mainbot github action

ação mainbot-github

Esta ação do GitHub permite que você carregue automaticamente arquivos do seu repositório para um endpoint da API do mainbot.

Entradas

glob-pattern

Obrigatório O padrão glob usado para localizar arquivos no repositório. Padrão: ./docs/** .

namespace

Obrigatório O namespace do endpoint da API mainbot.

api-url

Obrigatório O endpoint da API Mainbot para o qual os arquivos serão carregados.

client-id

Opcional O ID do cliente para autenticação OAuth, se exigido pela sua API.

client-secret

Opcional O segredo do cliente para autenticação OAuth, se exigido pela sua API.

token-endpoint

Opcional O ponto final do token para autenticação OAuth, se exigido pela sua API.

Características

• Correspondência de padrão glob para seleção de arquivos.
• Faça upload de arquivos com metadados, incluindo caminhos de arquivo relativos, repositório e proprietário.
• Suporte para autenticação de token OAuth.

Pré-requisitos

• Um repositório GitHub onde esta ação pode ser implementada.
• Credenciais necessárias (como client_id e client_secret ) se a API de destino exigir autenticação OAuth.

Instalação

1. Adicione ação GitHub ao seu repositório

   Crie um diretório .github/workflows na raiz do seu repositório (se ainda não existir) e adicione um novo arquivo YAML para o seu fluxo de trabalho (por exemplo, upload-files.yml ).

2. Configurar arquivo de fluxo de trabalho

   Configure seu arquivo de fluxo de trabalho com as etapas necessárias. Abaixo está um exemplo de configuração:

    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. Definir segredos do GitHub

   Vá para Configurações> Segredos do seu repositório e adicione seu CLIENT_ID e CLIENT_SECRET .

Uso

Uma vez instalada, a ação será executada automaticamente com base nos gatilhos definidos no seu arquivo de fluxo de trabalho (por exemplo, em cada push para o branch main ). A ação irá:

1. Procure arquivos em seu repositório que correspondam ao padrão glob definido.
2. Para cada arquivo encontrado, carregue-o no endpoint da API especificado com o conteúdo do arquivo e seu caminho relativo nos metadados.

Apoiar

Para suporte, problemas ou solicitações de recursos, registre um problema no repositório GitHub.