mainbot github action

acción-github-mainbot

Esta acción de GitHub le permite cargar archivos automáticamente desde su repositorio a un punto final de API de mainbot.

Entradas

glob-pattern

Obligatorio El patrón global utilizado para buscar archivos en el repositorio. Valor predeterminado: ./docs/** .

namespace

Obligatorio El espacio de nombres del punto final de la API de mainbot.

api-url

Requerido El punto final de la API de Mainbot al que se cargarán los archivos.

client-id

Opcional El ID de cliente para la autenticación OAuth, si lo requiere su API.

client-secret

Opcional El secreto del cliente para la autenticación OAuth, si lo requiere su API.

token-endpoint

Opcional El punto final del token para la autenticación OAuth, si lo requiere su API.

Características

• Coincidencia de patrones globales para seleccionar archivos.
• Cargue archivos con metadatos, incluidas rutas de archivo relativas, repositorio y propietario.
• Soporte de autenticación de token OAuth.

Requisitos previos

• Un repositorio de GitHub donde se puede implementar esta acción.
• Credenciales necesarias (como client_id y client_secret ) si la API de destino requiere autenticación OAuth.

Instalación

1. Agregue la acción de GitHub a su repositorio

   Cree un directorio .github/workflows en la raíz de su repositorio (si aún no existe) y agregue un nuevo archivo YAML para su flujo de trabajo (por ejemplo, upload-files.yml ).

2. Configurar archivo de flujo de trabajo

   Configure su archivo de flujo de trabajo con los pasos requeridos. A continuación se muestra una configuración de ejemplo:

    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. Establecer secretos de GitHub

   Vaya a Configuración > Secretos de su repositorio y agregue su CLIENT_ID y CLIENT_SECRET .

Uso

Una vez instalada, la acción se ejecutará automáticamente en función de los activadores definidos en su archivo de flujo de trabajo (por ejemplo, en cada envío a la rama main ). La acción:

1. Busque archivos en su repositorio que coincidan con el patrón global definido.
2. Para cada archivo encontrado, cárguelo en el punto final API especificado con el contenido del archivo y su ruta relativa en los metadatos.

Apoyo

Para soporte, problemas o solicitudes de funciones, presente un problema en el repositorio de GitHub.