إعداد التكامل المستمر باستخدام GitHub Actions

[Discourse]

نظرة عامة

لبناء امتداد قوي لـ Discourse، قد يكون من الحكمة دمج التكامل المستمر (CI) في إضافة أو مكون السمة الخاص بك. سيساعد ذلك في اكتشاف الأخطاء مبكرًا وتقليل فرص وجود أخطاء في الكود الخاص بك.

إن إعداد سير عمل CI باستخدام إجراءات GitHub لأتمتة عمليات البناء والاختبار هو نهج يتبعه فريق Discourse في جميع مكوناتنا، ونوصيك بالقيام بنفس الشيء.

الإعداد

لإضافة سير عمل أوتوماتيكي لإجراءات GitHub للكشف، تحتاج إلى إنشاء مجلد .github/workflows في المجلد الجذري لمستودعك.

داخل مجلد workflows، يمكنك تعريف مجموعة من الأتمتة التي ستحتاج إجراءات GitHub إلى تشغيلها. على سبيل المثال، يمكن أن تكون هذه ملفات .yml للتحقق من الكود (linting) والاختبارات.

لقد أنشأنا سير عمل قوالب لكل من الإضافات و مكونات السمات والتي يمكنك الاستفادة منها. ترتبط هذه التعريفات بـ “سير العمل القابل لإعادة الاستخدام” الخاص بنا هنا.

في مستودع الهيكل القالب على GitHub، يمكنك النقر فوق زر استخدام هذا القالب لإنشاء مستودع لإضافة/مكون سمة بناءً على القالب.

بدلاً من ذلك، إذا كان لديك مشروع تريد إضافة سير العمل إليه، فقم ببساطة بنسخ سير العمل ذي الصلة إلى مجلد .github/workflows/ في مستودعك:

الإضافات: discourse-plugin.yml

السمات ومكونات السمات: discourse-theme.yml

هذه القوالب مقيدة بإصدار رئيسي محدد من سير العمل القابل لإعادة الاستخدام الخاص بنا. التحسينات الصغيرة التي نجريها على سير العمل ستدخل حيز التنفيذ تلقائيًا في سمة/إضافة الخاص بك. بالنسبة للتغييرات الجوهرية (مثل إدخال أداة تحقق جديدة)، سنقوم بزيادة الإصدار الرئيسي لسير العمل القابل لإعادة الاستخدام، وستحتاج إلى تحديث سير العمل الخاص بك للإشارة إلى الإصدار الجديد.

تفضل! أنت جاهز تمامًا! ببساطة، قم بإنشاء التزام (commit) أو PR إلى مستودعك، وستقوم إجراءات GitHub بالكشف التلقائي عن سير العمل وبدء تشغيل المهام.

ستعرض إجراءات GitHub تفصيلًا لكل اختبار، وبعد التشغيل ستشير إما إلى أو اعتمادًا على ما إذا كان الاختبار قد نجح أم فشل.

إذا فشل اختبار، فإن النقر على التفاصيل سيعطيك بعض المعلومات حول ما فشل، مما قد يمنحك أدلة حول ما الخطأ في كودك وما يحتاج إلى إصلاح.

شاهد مثالاً

أضف اختباراتك الخاصة

لكي تعمل اختبارات الإضافات والمكونات بفعالية، من المهم أن تكتب اختبارات لإضافة أو مكون السمة الخاص بك.

لمزيد من التفاصيل حول كيفية كتابة اختبارات الواجهة الأمامية باستخدام EmberJS، راجع:

• Write acceptance tests and component tests for Ember code in Discourse
• Introduction - Testing - Ember Guides

لمزيد من التفاصيل حول كتابة اختبارات RSpec باستخدام Rails، راجع:

• RSpec - تطوير قائم على السلوك لـ Ruby

أمثلة

لصالحك، اخترنا بعض الأمثلة على الإضافات ومكونات السمات التي تتضمن اختبارات قوية مدمجة:

إضافة / مكون	اختبارات جانب العميل	اختبارات جانب الخادم
Assign	عرض المجلد	عرض المجلد
Calendar	عرض المجلد	عرض المجلد
Reactions	عرض المجلد	عرض المجلد
Right Sidebar Blocks	عرض المجلد
Tag Icons	عرض المجلد
Table Builder	عرض المجلد

---

هذا المستند خاضع للتحكم في الإصدارات - اقترح التغييرات على GitHub.

[pfaffman (Jay Pfaffman)]

قد تذكر GitHub - discourse/discourse-theme-skeleton: Template for Discourse themes صراحةً وتلاحظ أنه يجب عليك مراقبته لتدوين التغييرات في تلك الملفات.

[Simon_Manning]

@pfaffman

يجب عليك مشاهدته لتدوين التغييرات في تلك الملفات

نأمل أن يتم دمج سير العمل القابل لإعادة الاستخدام، مما يجعل هذا الجزء أقل أهمية حيث ستستخدم المستودعات الجديدة التي تم إنشاؤها من القالب سير العمل مباشرة من مستودع القالب.

[keegan (Keegan George)]

شكراً @pfaffman و @Simon_Manning، نقاط جيدة. لقد قمت بتحديث المنشور الأصلي وفقًا لذلك.

[david (David Taylor)]

لقد قمت بتحديث OP لتضمين تعليمات لاستخدام “سير العمل القابل لإعادة الاستخدام” الجديد لدينا. يمكن الآن تطبيق التعديلات الطفيفة التي نجريها على تعريفات سير العمل تلقائيًا على السمات/المكونات الإضافية الخاصة بك دون أي عمل يدوي.

لقد أنشأنا قوالب سير عمل لكل من المكونات الإضافية و مكونات السمات التي يمكنك الاستفادة منها. تتصل هذه بسير العمل القابل لإعادة الاستخدام الخاص بنا هنا.

…

المكونات الإضافية: discourse-plugin.yml

السمات ومكونات السمات: discourse-theme.yml

\u003e هذه القوالب مقفلة لإصدار رئيسي محدد من سير العمل القابل لإعادة الاستخدام الخاص بنا. ستدخل التحسينات الصغيرة التي نجريها على سير العمل حيز التنفيذ تلقائيًا في السمة/المكون الإضافي الخاص بك. بالنسبة للتغييرات التي قد تؤدي إلى كسر التوافق (على سبيل المثال، تقديم مدقق جديد)، سنقوم بترقية الإصدار الرئيسي لسير العمل القابل لإعادة الاستخدام، وستحتاج إلى تحديث سير العمل الخاص بك للإشارة إلى الإصدار الجديد.

[merefield (Robert)]

هل أحتاج إلى القيام بأي شيء خاص لاختبار الإضافة ضد أحدث الاختبارات المارة و المستقرة؟

[Simon_Manning]

يستخدم سير عمل هيكل المكون الإضافي ما يلي، والذي أعتقد أنه سيختبر مقابل الفرع الافتراضي، لذا main. يحتوي سير العمل القابل لإعادة الاستخدام على إدخال اختياري core_ref وبقدر ما أستطيع أن أقول، بدونه سيتم سحب الفرع الافتراضي لمستودع discourse/discourse.

jobs:
  ci:
    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1

لا يمكنني تحديد ما إذا كان ذلك يقتصر فعليًا على الاختبار مقابل main أم لا، ولكن إذا كان الأمر كذلك، يمكنك إضافة استراتيجية مصفوفة للتشغيل مرة واحدة لكل مرجع تريد الاختبار مقابله.

jobs:
  ci:
    strategy:
      matrix:
        target: [tests-passed, stable]
    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1
    with:
      core_ref: ${{ matrix.target }}

[david (David Taylor)]

نعم، هذا يجب أن يفي بالغرض. أو يمكنك ببساطة كتابة المهمتين يدويًا دون استخدام مصفوفة:

name: Discourse Plugin

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  ci:
    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1

  ci-stable:
    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1
    with:
      core_ref: stable

تجدر الإشارة إلى أن هذه المهام لن تتحقق من .discourse-compatiblity. لذا، فإن هذا يستحق القيام به فقط على المكونات الإضافية التي لا تستخدم هذا الملف، وتحتاج إلى أن تكون متوافقة مع كل من main و stable في نفس الوقت.

بالنسبة لجميع السمات/المكونات الإضافية العامة لـ CDCK، نضيف إدخالًا إلى discourse-compatibility “لتجميدها” عند كل إصدار مستقر. بعد ذلك، لا نحتاج إلى القلق بشأن التوافق المستقر أثناء تطويرها.

[merefield (Robert)]

شكرا لكما.

@david

لجميع السمات/الإضافات العامة لـ CDCK، نضيف إدخالًا إلى discourse-compatibility لـ “تجميدها” عند كل إصدار مستقر.

نعم، هذا هو النهج الأكثر مباشرة على الأرجح. الجانب السلبي الوحيد هو أنه قد يؤخر الميزات (وإصلاحات الأخطاء الجديدة)