فحص شارات سير العمل
توفر شارات حالة سير العمل رؤية سريعة لصحة مشروعك وحالة البناء. إنها ضرورية لإيصال جودة المشروع للمستخدمين والمساهمين وأصحاب المصلحة الذين يزورون مستودعك.
فهم شارات سير العمل
شارات الحالة هي صور ديناميكية تعرض الحالة الحالية لمهام سير عمل GitHub Actions. يتم تحديثها تلقائيا لتعكس أحدث حالة بناء وتوفر ملاحظات مرئية فورية حول صحة مسار CI/CD لمشروعك.
سبب أهمية شارات سير العمل
مصداقية المشروع: تشير الشارات إلى أن مشروعك يتبع ممارسات التطوير الجيدة التقييم السريع: يمكن للمساهمين معرفة ما إذا كان المشروع مستقرا على الفور ضمان الجودة: فشل الشارات ينبه المشرفين إلى المشكلات التي تحتاج إلى الاهتمام المظهر الاحترافي: تعمل الشارات المهيأة جيدا على تحسين الصورة الاحترافية لمشروعك
إنشاء شارات سير العمل وتكوينها
بناء جملة الشارة الأساسية
تنسيق عنوان URL القياسي لشارات سير عمل GitHub Actions هو:
https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg
مكونات عنوان URL:
-
<OWNER>اسم مستخدم GitHub أو اسم مؤسستك: -
<REPOSITORY>اسم المستودع: -
<WORKFLOW_FILE>اسم ملف سير العمل الخاص بك (على سبيل المثال،ci.yml)
شارات خاصة بالفرع
عرض الحالة لفروع معينة عن طريق إضافة معلمة الفرع:
https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg?branch=<BRANCH_NAME>
تطبيقات الشارات العملية
تكامل README.md الأساسي
# My Awesome Project
[](https://github.com/myorg/myproject/actions/workflows/ci.yml)
A description of your project...
عرض شارة متعددة الفروع
# Project Status
| Branch | Status |
| ------- | ------------------------------------------------------------------------------------------------------- |
| Main |  |
| Develop |  |
| Release |  |
مجموعة شارات متقدمة
# Build & Quality Status
[](https://github.com/myorg/myproject/actions/workflows/ci.yml)
[](https://github.com/myorg/myproject/actions/workflows/security.yml)
[](https://github.com/myorg/myproject/actions/workflows/deploy.yml)
[](https://codecov.io/gh/myorg/myproject)
[](LICENSE)
أفضل ممارسات شارة سير العمل
وضع الشارة الإستراتيجية
أعلى الملف التمهيدي: الموقع الأكثر وضوحا لحالة الإنشاء الأساسية قسم الحالة: قسم مخصص لصحة المشروع قوالب طلب السحب: تضمين شارات في أوصاف العلاقات العامة للسياق
<!-- In your README.md -->
# Project Name
<!-- Rest of your README content -->
## Status Dashboard
### Build Pipeline
- **Main Branch**: 
- **Development**: 
### Quality Metrics
- **Code Coverage**: 
- **Security**: 
أسماء سير العمل ذات المغزى
تأكد من أن ملفات سير العمل تحتوي على أسماء وصفية تنشئ تسميات شارات واضحة:
# .github/workflows/ci.yml
name: "CI Pipeline" # Creates badge with "CI Pipeline" label
# .github/workflows/deploy-production.yml
name: "Production Deployment" # Creates badge with "Production Deployment" label
# .github/workflows/security-scan.yml
name: "Security Analysis" # Creates badge with "Security Analysis" label
أنماط تنظيم الشارة
مجمعة حسب الوظيفة:
## Build & Test
## Deployment
## Quality & Security
شارات تفاعلية مع روابط
اجعل الشارات قابلة للنقر لتوفير وصول مباشر إلى تفاصيل سير العمل:
[](https://github.com/owner/repo/actions/workflows/ci.yml)
[](https://github.com/owner/repo/actions/workflows/deploy.yml)
تكامل الشارة المخصصة
شارات خدمة الجهات الخارجية
استكمال شارات GitHub Actions بمؤشرات الخدمة الخارجية:
<!-- Combine GitHub Actions with external services -->
[](https://codecov.io/gh/owner/repo)
[](https://dependabot.com)
[](https://badge.fury.io/js/package-name)
محتوى الشارة الديناميكية
إنشاء شارات تعرض معلومات إضافية:
<!-- Show specific branch status -->
<!-- Show latest release status -->
استكشاف أخطاء الشارة وإصلاحها ومراقبتها
المشكلات والحلول الشائعة
الشارة لا تتحدث:
- التحقق من مسار ملف سير العمل في عنوان URL
- التحقق من اكتمال سير العمل مرة واحدة على الأقل
- تأكد من تطابق اسم سير العمل تماما
تعرض الشارة الحالة "غير معروفة":
- ملف سير العمل غير موجود أو يحتوي على أخطاء في بناء الجملة
- المستودع أو سير العمل خاص بدون أذونات مناسبة
- معلمات عنوان URL مشوهة
مراقبة حالة الشارة
إعداد التنبيهات لتغييرات حالة الشارة:
# .github/workflows/badge-monitor.yml
name: Badge Status Monitor
on:
workflow_run:
workflows: ["CI Pipeline"]
types: [completed]
jobs:
notify-status:
runs-on: ubuntu-latest
if: ${{ github.event.workflow_run.conclusion == 'failure' }}
steps:
- name: Notify team of failing badge
uses: 8398a7/action-slack@v3
with:
status: failure
text: "🚨 CI Pipeline badge is now showing failure status"
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
استراتيجيات شارة متقدمة
لوحة معلومات متعددة البيئات
## Environment Status
| Environment | Build | Deploy | Health Check |
| --------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| **Development** |  |  |  |
| **Staging** |  |  |  |
| **Production** |  |  |  |
لوحة معلومات سلامة المشروع
# Project Health Dashboard
## Core Pipeline
[](https://github.com/owner/repo/actions/workflows/build.yml)
[](https://github.com/owner/repo/actions/workflows/test.yml)
[](https://github.com/owner/repo/actions/workflows/lint.yml)
## Security & Quality
[](https://github.com/owner/repo/actions/workflows/security.yml)
[](https://github.com/owner/repo/actions/workflows/audit.yml)
[](https://sonarcloud.io/dashboard?id=owner_repo)
## Deployment Status
[](https://github.com/owner/repo/actions/workflows/deploy-staging.yml)
[](https://github.com/owner/repo/actions/workflows/deploy-prod.yml)
تعد شارات سير العمل أكثر من مجرد مؤشرات حالة، فهي أداة اتصال تبني الثقة وتوفر الشفافية وتوضح التزامك بجودة التعليمات البرمجية. استخدمها بشكل استراتيجي لإنشاء عرض تقديمي احترافي وغني بالمعلومات.
للحصول على وثائق الشارة، راجع إضافة شارة حالة سير العمل.