mainbot github action

mainbot-github-action

يمكّنك إجراء GitHub هذا من تحميل الملفات تلقائيًا من المستودع الخاص بك إلى نقطة نهاية واجهة برمجة تطبيقات mainbot.

المدخلات

glob-pattern

مطلوب النمط الشامل المستخدم للعثور على الملفات في المستودع. الافتراضي: ./docs/** .

namespace

مطلوب مساحة الاسم لنقطة نهاية واجهة برمجة تطبيقات mainbot.

api-url

مطلوب نقطة نهاية Mainbot API التي سيتم تحميل الملفات إليها.

client-id

اختياري معرف العميل لمصادقة OAuth، إذا كانت واجهة برمجة التطبيقات الخاصة بك مطلوبة.

client-secret

اختياري: سر العميل لمصادقة OAuth، إذا كانت واجهة برمجة التطبيقات الخاصة بك مطلوبة.

token-endpoint

اختياري: نقطة نهاية الرمز المميز لمصادقة OAuth، إذا كانت واجهة برمجة التطبيقات الخاصة بك مطلوبة.

سمات

• مطابقة نمط الكرة الأرضية لاختيار الملفات.
• قم بتحميل الملفات باستخدام البيانات الوصفية بما في ذلك مسارات الملفات النسبية والمستودع والمالك.
• دعم مصادقة رمز OAuth.

المتطلبات الأساسية

• مستودع GitHub حيث يمكن تنفيذ هذا الإجراء.
• بيانات الاعتماد الضرورية (مثل client_id و client_secret ) إذا كانت واجهة برمجة التطبيقات المستهدفة تتطلب مصادقة OAuth.

تثبيت

1. أضف إجراء GitHub إلى مستودعك

   أنشئ دليل .github/workflows في جذر مستودعك (إذا لم يكن موجودًا بالفعل)، وأضف ملف YAML جديد لسير عملك (على سبيل المثال، upload-files.yml ).

2. تكوين ملف سير العمل

   قم بإعداد ملف سير العمل الخاص بك بالخطوات المطلوبة. فيما يلي مثال للتكوين:

    name : Upload Files to API
   
   on :
     workflow_dispatch : {} # Enable manual triggering
     push :
       branches :
         - main  # Set your branch here
       paths :
         - ' docs/** '  # Set your docs folder path here
   
   jobs :
     upload :
       runs-on : ubuntu-latest
       steps :
         - name : Checkout repository
           uses : actions/checkout@v2
         
         - name : Upload Files
           uses : savantly-net/mainbot-github-action@main
           with :
             glob-patterns : ' **/*.txt '  # Set your file pattern here
             namespace : ' /admin '
             api-url : ' https://mainbot.savantly.net ' # Set your Mainbot API endpoint here
             client-id : ${{ secrets.CLIENT_ID }} # Set your client ID here
             client-secret : ${{ secrets.CLIENT_SECRET }} # Set your client secret here
             token-endpoint : ' https://mainbot.savantly.net/oauth/token ' # Set your token endpoint here

3. تعيين أسرار جيثب

   انتقل إلى إعدادات المستودع الخاص بك > الأسرار وأضف CLIENT_ID و CLIENT_SECRET .

الاستخدام

بمجرد التثبيت، سيتم تشغيل الإجراء تلقائيًا بناءً على المشغلات المحددة في ملف سير العمل الخاص بك (على سبيل المثال، في كل دفعة إلى الفرع main ). الإجراء سوف:

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

يدعم

للحصول على الدعم أو المشكلات أو طلبات الميزات، يرجى تقديم مشكلة في مستودع GitHub.