mainbot github action

mainbot-github-action

Cette action GitHub vous permet de télécharger automatiquement des fichiers de votre référentiel vers un point de terminaison d'API mainbot.

Entrées

glob-pattern

Obligatoire Le modèle global utilisé pour rechercher des fichiers dans le référentiel. Par défaut : ./docs/** .

namespace

Obligatoire L'espace de noms du point de terminaison de l'API mainbot.

api-url

Obligatoire Le point de terminaison de l'API Mainbot vers lequel les fichiers seront téléchargés.

client-id

Facultatif L'ID client pour l'authentification OAuth, si votre API l'exige.

client-secret

Facultatif Le secret client pour l'authentification OAuth, si votre API l'exige.

token-endpoint

Facultatif Le point de terminaison du jeton pour l'authentification OAuth, si votre API l'exige.

Caractéristiques

• Correspondance de modèle Glob pour la sélection de fichiers.
• Téléchargez des fichiers avec des métadonnées, notamment les chemins de fichiers relatifs, le dépôt et le propriétaire.
• Prise en charge de l'authentification par jeton OAuth.

Conditions préalables

• Un référentiel GitHub où cette action peut être implémentée.
• Informations d'identification nécessaires (comme client_id et client_secret ) si l'API cible nécessite une authentification OAuth.

Installation

1. Ajoutez une action GitHub à votre référentiel

   Créez un répertoire .github/workflows à la racine de votre référentiel (s'il n'existe pas déjà) et ajoutez un nouveau fichier YAML pour votre workflow (par exemple, upload-files.yml ).

2. Configurer le fichier de flux de travail

   Configurez votre fichier de workflow avec les étapes requises. Ci-dessous un exemple de configuration :

    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. Définir les secrets de GitHub

   Accédez aux Paramètres > Secrets de votre référentiel et ajoutez votre CLIENT_ID et CLIENT_SECRET .

Usage

Une fois installée, l'action s'exécutera automatiquement en fonction des déclencheurs définis dans votre fichier de workflow (par exemple, à chaque poussée vers la branche main ). L’action :

1. Recherchez les fichiers dans votre référentiel correspondant au modèle global défini.
2. Pour chaque fichier trouvé, téléchargez-le sur le point de terminaison d'API spécifié avec le contenu du fichier et son chemin relatif dans les métadonnées.

Soutien

Pour toute assistance, problèmes ou demandes de fonctionnalités, veuillez signaler un problème sur le référentiel GitHub.