mainbot github action

mainbot-github-aksi

Tindakan GitHub ini memungkinkan Anda mengunggah file secara otomatis dari repositori Anda ke titik akhir API mainbot.

masukan

glob-pattern

Diperlukan Pola glob yang digunakan untuk menemukan file di repositori. Bawaan: ./docs/** .

namespace

Diperlukan Namespace dari titik akhir API mainbot.

api-url

Diperlukan Titik akhir API Mainbot tempat file akan diunggah.

client-id

Opsional ID klien untuk autentikasi OAuth, jika diperlukan oleh API Anda.

client-secret

Opsional Rahasia klien untuk autentikasi OAuth, jika diwajibkan oleh API Anda.

token-endpoint

Opsional Titik akhir token untuk autentikasi OAuth, jika diperlukan oleh API Anda.

Fitur

• Pencocokan pola glob untuk memilih file.
• Unggah file dengan metadata termasuk jalur file relatif, repo, dan pemilik.
• Dukungan otentikasi token OAuth.

Prasyarat

• Repositori GitHub tempat tindakan ini dapat diterapkan.
• Kredensial yang diperlukan (seperti client_id dan client_secret ) jika API target memerlukan autentikasi OAuth.

Instalasi

1. Tambahkan Tindakan GitHub ke Repositori Anda

   Buat direktori .github/workflows di root repositori Anda (jika belum ada), dan tambahkan file YAML baru untuk alur kerja Anda (misalnya, upload-files.yml ).

2. Konfigurasikan File Alur Kerja

   Siapkan file alur kerja Anda dengan langkah-langkah yang diperlukan. Di bawah ini adalah contoh konfigurasi:

    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. Tetapkan Rahasia GitHub

   Buka Pengaturan > Rahasia repositori Anda dan tambahkan CLIENT_ID dan CLIENT_SECRET Anda.

Penggunaan

Setelah diinstal, tindakan akan berjalan secara otomatis berdasarkan pemicu yang ditentukan dalam file alur kerja Anda (misalnya, pada setiap push ke cabang main ). Tindakan tersebut akan:

1. Cari file di repositori Anda yang cocok dengan pola glob yang ditentukan.
2. Untuk setiap file yang ditemukan, unggah file tersebut ke titik akhir API yang ditentukan dengan konten file dan jalur relatifnya dalam metadata.

Mendukung

Untuk dukungan, masalah, atau permintaan fitur, harap ajukan masalah di repositori GitHub.