mainbot github action

mainbot-github-action

此 GitHub 操作使您能够自动将文件从存储库上传到 mainbot API 端点。

输入

glob-pattern

必需用于在存储库中查找文件的 glob 模式。默认值： ./docs/** 。

namespace

必需mainbot API 端点的命名空间。

api-url

必需文件将上传到的 Mainbot API 端点。

client-id

可选OAuth 身份验证的客户端 ID（如果您的 API 需要）。

client-secret

可选用于 OAuth 身份验证的客户端密钥（如果您的 API 需要）。

token-endpoint

可选用于 OAuth 身份验证的令牌端点（如果您的 API 需要）。

特征

• 用于选择文件的全局模式匹配。
• 上传带有元数据的文件，包括相对文件路径、存储库和所有者。
• OAuth 令牌身份验证支持。

先决条件

• 可以在其中实施此操作的 GitHub 存储库。
• 如果目标 API 需要 OAuth 身份验证，则需要必要的凭据（例如client_id和client_secret ）。

安装

1. 将 GitHub Action 添加到您的存储库

   在存储库的根目录中创建.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 存储库上提交问题。