انتقل إلى المحتوى

الـ badge: حالة الـ workflow

ملاحظة

تحتاج هذه الميزة إلى تفعيل Actions على الـ repository من Settings ← Advanced Settings ← Enable Repository Actions، وإلى runner متاح يوفّره مدير الخدمة. إن لم يظهر تبويب Actions في الـ repository فالميزة غير متاحة بعد، وكل ما هنا ينطبق «إن كانت مفعّلة».

لكي يعرف زائر الـ repository حالة مشروعك من أول سطر في README، ضع badge: صورة SVG بعنوان ثابت يولّدها ليڤانت غيت (LevantGit)، تتحدّث مع كل workflow run فتقول passing بالأخضر أو failing بالأحمر. تشرح هذه الصفحة نمط العنوان وخياراته، وكيف تضع الـ badge في Markdown أو HTML.

ما هو الـ badge؟

الـ badge صورة SVG صغيرة يولّدها ليڤانت غيت (LevantGit) تلقائيًا، تعرض اسم الـ workflow وحالة آخر workflow run له: passing بالأخضر عند النجاح، وfailing بالأحمر عند الفشل، وحالات أخرى مثل waiting أو running. تُحدَّث الصورة من تلقاء نفسها مع كل workflow run جديد. وهي متوافقة في صيغتها مع badge الخاص بـ GitHub Actions، فإن كنت تستخدم badge هناك فالأمر مألوف.

عنوان الـ badge

نمط العنوان:

https://levantgit.com/{owner}/{repo}/actions/workflows/{workflow_file}/badge.svg?branch={branch}&event={event}&style={style}
  • {owner}: الـ owner، أي اسم المستخدم أو الـ organization.
  • {repo}: اسم الـ repository.
  • {workflow_file}: اسم ملف الـ workflow كما هو في .gitea/workflows/، مثل demo.yaml.
  • {branch}: اختياري. الـ branch الذي تريد حالته. الافتراضي هو الـ default branch للـ repository.
  • {event}: اختياري. حدث التشغيل (مثل push أو pull_request). الافتراضي: بلا تصفية.
  • {style}: اختياري. شكل الـ badge: flat (الافتراضي) أو flat-square.

مثال لـ repository باسم myapp يملكه المستخدم sara، و workflow في الملف build.yaml، على الـ branch المسمّى main:

https://levantgit.com/sara/myapp/actions/workflows/build.yaml/badge.svg?branch=main

وضع الـ badge في README

في Markdown، اجعل الـ badge صورةً ورابطًا إلى تبويب Actions في الوقت نفسه، ليصل القارئ إلى السجل بضغطة واحدة:

[![Build](https://levantgit.com/sara/myapp/actions/workflows/build.yaml/badge.svg?branch=main)](https://levantgit.com/sara/myapp/actions)

وفي HTML:

<a href="https://levantgit.com/sara/myapp/actions">
  <img src="https://levantgit.com/sara/myapp/actions/workflows/build.yaml/badge.svg?branch=main" alt="Build status">
</a>

نصيحة

إن كان في الـ repository عدة workflows (اختبارات، بناء، فحص) فضع badge لكل ملف في سطر واحد؛ هكذا يرى الزائر حالة المشروع كاملة من أول سطر في README.

الـ badge والـ repositories الخاصة

يُقدَّم الـ badge من الـ repository نفسه، فإن كان private فلن تظهر الصورة إلا لمن يملك حق الوصول إليه وهو مسجّل الدخول. في الصفحات العامة خارج ليڤانت غيت ستظهر مكسورة. هذا ليس خطأ بل حماية لحالة مشروعك الخاص.

إن لم يظهر الـ badge

  • تأكّد من اسم ملف الـ workflow بالضبط (مع الامتداد .yaml أو .yml).
  • تأكّد أن الـ workflow عمل مرة واحدة على الأقل على الـ branch المطلوب؛ قبل أول workflow run قد يعرض الـ badge حالة «بلا حالة».
  • تأكّد أن تبويب Actions ظاهر في الـ repository؛ إن لم يكن فالميزة غير مفعّلة.

ماذا بعد؟

هذه الصفحة مبنية على وثائق Gitea (رخصة MIT) بعد ترجمتها وتبسيطها.