mainbot github action Download - mainbot github action Quellcode herunterladen

mainbot github action

AI-Quellcode

1.0.0

Herunterladen

Mainbot-Github-Aktion

Mit dieser GitHub-Aktion können Sie Dateien automatisch aus Ihrem Repository auf einen Mainbot-API-Endpunkt hochladen.

Eingaben

`glob-pattern`

Erforderlich Das Glob-Muster, das zum Suchen von Dateien im Repository verwendet wird. Standard: ./docs/** .

`namespace`

Erforderlich Der Namespace des Mainbot-API-Endpunkts.

`api-url`

Erforderlich Der Mainbot-API-Endpunkt, auf den Dateien hochgeladen werden.

`client-id`

Optional Die Client-ID für die OAuth-Authentifizierung, falls für Ihre API erforderlich.

`client-secret`

Optional Das Client-Geheimnis für die OAuth-Authentifizierung, falls für Ihre API erforderlich.

`token-endpoint`

Optional Der Token-Endpunkt für die OAuth-Authentifizierung, falls für Ihre API erforderlich.

Merkmale

Glob-Mustervergleich zur Auswahl von Dateien.
Laden Sie Dateien mit Metadaten hoch, einschließlich relativer Dateipfade, Repo und Besitzer.
Unterstützung für die OAuth-Token-Authentifizierung.

Voraussetzungen

Ein GitHub-Repository, in dem diese Aktion implementiert werden kann.
Erforderliche Anmeldeinformationen (wie client_id und client_secret ), wenn die Ziel-API eine OAuth-Authentifizierung erfordert.

Installation

Fügen Sie Ihrem Repository eine GitHub-Aktion hinzu
Erstellen Sie ein .github/workflows Verzeichnis im Stammverzeichnis Ihres Repositorys (sofern es noch nicht vorhanden ist) und fügen Sie eine neue YAML-Datei für Ihren Workflow hinzu (z. B. upload-files.yml ).

Workflow-Datei konfigurieren

Richten Sie Ihre Workflow-Datei mit den erforderlichen Schritten ein. Nachfolgend finden Sie eine Beispielkonfiguration:

 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

Legen Sie GitHub-Geheimnisse fest
Gehen Sie zu Einstellungen > Geheimnisse Ihres Repositorys und fügen Sie Ihre CLIENT_ID und CLIENT_SECRET hinzu.

Verwendung

Nach der Installation wird die Aktion automatisch basierend auf den definierten Auslösern in Ihrer Workflow-Datei ausgeführt (z. B. bei jedem Push zum main ). Die Aktion wird:

Suchen Sie in Ihrem Repository nach Dateien, die dem definierten Glob-Muster entsprechen.
Laden Sie jede gefundene Datei mit dem Inhalt der Datei und ihrem relativen Pfad in den Metadaten auf den angegebenen API-Endpunkt hoch.