GitHub Actions

يشغّل ritla-app/scan-action فحصًا من ريتلا لأحد مشاريعك من داخل سير عمل في GitHub، ويُفشل المهمة حين يجد ملاحظات بالخطورة التي تحددها أو أعلى. إنه الفحص نفسه الذي يشغّله ritla scan في سطر الأوامر، في خطوة واحدة من سير العمل.

سير العمل#

أنشئ مفتاح API للفحص من الإعدادات في لوحة التحكم، واحفظه سرًّا في المستودع باسم RITLA_API_KEY. معرّف المشروع هو قيمة UUID في رابط المشروع في لوحة التحكم.

name: Arabic QA
on:
  push:
    branches: [main]
jobs:
  ritla:
    runs-on: ubuntu-latest
    timeout-minutes: 40
    steps:
      - uses: ritla-app/scan-action@v1
        with:
          api-key: ${{ secrets.RITLA_API_KEY }}
          project-id: <project UUID from the dashboard URL>
          fail-on: high

المدخلات#

المخرجات#

يعرض ملخص المهمة النتيجة وعدد الصفحات والملاحظات حسب الخطورة ورابط التقرير.

ما الذي تتوقعه#

• يستغرق الفحص دقائق لا ثواني، فهو يعرض كل صفحة بثلاثة مقاسات عرض: سطح المكتب والجهاز اللوحي والجوال. اجعل timeout-minutes للمهمة أطول من timeout-seconds، كما في سير العمل أعلاه.
• كل تشغيل يستهلك فحصًا واحدًا من حصة خطتك الشهرية، فشغّله عند كل push إلى الفرع الرئيسي أو على جدول زمني، لا مع كل commit.
• طلبات الدمج القادمة من نسخ مشتقة (forks) لا تحصل على الأسرار، فلا يعمل الإجراء عليها.
• الفحص الذي يفشل أو تنتهي مهلته يُفشل المهمة، ولا يُحتسب نجاحًا أبدًا.
• يعمل على مشغّلات GitHub المستضافة بأنظمة Linux وmacOS وWindows، ويحتاج إلى bash وcurl وjq، وهي متوفرة فيها كلها.