mainbot github action

メインボット-github-アクション

この GitHub アクションを使用すると、リポジトリからメインボット API エンドポイントにファイルを自動的にアップロードできます。

入力

glob-pattern

必須リポジトリ内のファイルを検索するために使用される glob パターン。デフォルト: ./docs/** 。

namespace

必須mainbot API エンドポイントの名前空間。

api-url

必須ファイルがアップロードされる Mainbot API エンドポイント。

client-id

オプションAPI で必要な場合、OAuth 認証のクライアント ID。

client-secret

オプションAPI で必要な場合、OAuth 認証のクライアント シークレット。

token-endpoint

オプションAPI で必要な場合、OAuth 認証のトークン エンドポイント。

特徴

• ファイルを選択するためのグロブ パターン マッチング。
• 相対ファイル パス、リポジトリ、所有者などのメタデータを含むファイルをアップロードします。
• OAuth トークン認証のサポート。

前提条件

• このアクションを実装できる GitHub リポジトリ。
• ターゲット API が OAuth 認証を必要とする場合に必要な認証情報 ( client_idやclient_secretなど)。

インストール

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 リポジトリに問題を提出してください。