mainbot github action

mainbot-github-действие

Это действие GitHub позволяет автоматически загружать файлы из вашего репозитория в конечную точку API основного бота.

Входы

glob-pattern

Обязательно. Шаблон шаблона, используемый для поиска файлов в репозитории. По умолчанию: ./docs/** .

namespace

Обязательно Пространство имен конечной точки API основного бота.

api-url

Обязательно. Конечная точка Mainbot API, в которую будут загружены файлы.

client-id

Необязательно. Идентификатор клиента для аутентификации OAuth, если этого требует ваш API.

client-secret

Необязательно. Секрет клиента для аутентификации OAuth, если этого требует ваш API.

token-endpoint

Необязательно. Конечная точка токена для аутентификации OAuth, если этого требует ваш API.

Функции

• Сопоставление шаблонов Glob для выбора файлов.
• Загружайте файлы с метаданными, включая относительные пути к файлам, репозиторий и владельца.
• Поддержка аутентификации по токену OAuth.

Предварительные условия

• Репозиторий GitHub, где можно реализовать это действие.
• Необходимые учетные данные (например, client_id и client_secret ), если целевой API требует аутентификации OAuth.

Установка

1. Добавьте действие GitHub в свой репозиторий

   Создайте каталог .github/workflows в корне вашего репозитория (если он еще не существует) и добавьте новый файл YAML для вашего рабочего процесса (например, upload-files.yml ).

2. Настроить файл рабочего процесса

   Настройте файл рабочего процесса, выполнив необходимые шаги. Ниже приведен пример конфигурации:

    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. Установить секреты GitHub

   Перейдите в «Настройки» > «Секреты» вашего репозитория и добавьте свои CLIENT_ID и CLIENT_SECRET .

Использование

После установки действие будет запускаться автоматически на основе триггеров, определенных в вашем файле рабочего процесса (например, при каждом нажатии на main ветку). Действие будет:

1. Найдите в своем репозитории файлы, соответствующие определенному шаблону glob.
2. Для каждого найденного файла загрузите его в указанную конечную точку API с содержимым файла и его относительным путем в метаданных.

Поддерживать

Для получения поддержки, проблем или запросов на добавление функций сообщите о проблеме в репозитории GitHub.