PRを通じてプラグインを自動的に公開する
背景
プラグイン貢献者が他のユーザーにすでに使用されているDifyプラグインを更新する必要がある場合、そのプロセスは非常に煩雑です:貢献者はまずプラグインのソースコードを修正してバージョン番号を更新し、変更をプラグインソースリポジトリにプッシュし、フォークしたdify-pluginリポジトリに新しいブランチを作成する必要があります。その後、プラグインを手動でパッケージ化し、パッケージファイルをアップロードし、元のdify-pluginリポジトリにマージするためのPRを作成する必要があります。このプロセスはプラグインコードが変更されるたびに繰り返す必要があり、時間がかかり非効率的です。
このワークフローを簡素化するために、Plugin Auto-PRと呼ばれるGitHub Actionsベースの自動化ワークフローを構築しました。このツールを使用すると、プラグイン貢献者はプラグインのパッケージ化、ブランチのプッシュ、PRの作成を一度の操作で完了できます。
概念紹介
GitHub Actions
GitHub Actionsは、GitHubが提供する組み込みのCI/CDサービスで、様々なビルド、テスト、デプロイタスクを自動化します。
動作原理:トリガー条件(コードのプッシュなど)が満たされると、GitHubは自動的に仮想マシンを割り当ててワークフローを実行します。すべての操作はGitHubクラウドで完了します。
無料枠の制限:
- 公開リポジトリ:無制限
- プライベートリポジトリ:月2000分
Plugin Auto-PR
動作原理:
- プラグインソースリポジトリのmainブランチにコードをプッシュすると、ワークフローがトリガーされます
- ワークフローは
manifest.yaml
ファイルからプラグイン情報を読み取ります - プラグインを自動的に
.difypkg
ファイルとしてパッケージ化します - パッケージファイルをフォークした
dify-plugins
リポジトリにプッシュします - 新しいブランチを作成して変更をコミットします
- 上流リポジトリへのマージを自動的にPRで要求します
環境準備
リポジトリ要件
- すでに独自のプラグインソースコードリポジトリがある(例:
your-name/plugin-source
) - すでに独自のフォークしたプラグインリポジトリがある(例:
your-name/dify-plugins
)
権限要件
このワークフローが正常に機能するには、適切な権限が必要です:
- 十分な権限を持つGitHub Personal Access Token(PAT)を作成する必要があります
- そのPATはフォークしたリポジトリにコードをプッシュする権限が必要です
- そのPATは上流リポジトリにPRを作成する権限が必要です
パラメータと設定の詳細
必須パラメータ
プラグイン自動公開ワークフローでは、以下の重要な要素を正しく設定する必要があります:
manifest.yamlファイル:これは自動化プロセス全体の中核となる設定ソースです。以下のフィールドが正しいことを確認する必要があります:
name
:プラグイン名(パッケージ名とブランチ名の生成に使用)version
:バージョン番号(更新のたびに増分する必要あり)author
:GitHubユーザー名(ターゲットリポジトリパスの決定に使用)
PLUGIN_ACTION Secret:プラグインソースリポジトリにこのシークレットを正しく設定する必要があります。
- 値の要件:十分な権限を持つPersonal Access Token(PAT)である必要があります
- 権限要件:フォークしたリポジトリにブランチをプッシュし、上流リポジトリにPRを作成する能力
自動生成されるパラメータ
ワークフローは以下を自動的に処理し、手動介入は不要です:
- GitHubユーザー名:
manifest.yaml
のauthor
フィールドから読み取り - 作者フォルダ名:
author
フィールドと一致 - プラグイン名:
manifest.yaml
のname
フィールドから読み取り - ブランチ名:
bump-{plugin-name}-plugin-{version}
- パッケージファイル名:
{plugin-name}-{version}.difypkg
- PRのタイトルと内容:プラグイン名とバージョンに基づいて自動生成
インストールと設定手順
リポジトリの準備
公式のdify-plugins
リポジトリをフォークし、独自のプラグインソースリポジトリがあることを確認します。
シークレットの設定
プラグインソースリポジトリに移動し、Settings > Secrets and variables > Actions > New repository secretをクリックして、GitHubシークレットを作成します:
- 名前:
PLUGIN_ACTION
- 値:ターゲットリポジトリ(
your-name/dify-plugins
)への書き込み権限を持つGitHub Personal Access Token(PAT)
ワークフローファイルの作成
リポジトリに.github/workflows/
ディレクトリを作成し、このディレクトリにplugin-publish.yml
という名前のファイルを作成し、以下の内容をファイルにコピーします:
manifest.yamlの更新
manifest.yaml
ファイルが以下のフィールドを正しく設定していることを確認します:
使用ガイド
初回セットアッププロセス
自動公開ワークフローを初めて設定する場合は、次の手順を完了します:
- 公式の
dify-plugins
リポジトリをフォークしていることを確認します - プラグインソースリポジトリの構造が正しいことを確認します
- プラグインソースリポジトリに
PLUGIN_ACTION Secret
を設定します - ワークフローファイル
.github/workflows/plugin-publish.yml
を作成します manifest.yaml
ファイルのname
とauthor
フィールドが正しく設定されていることを確認します
以降の更新プロセス
セットアップが完了したら、新しいバージョンを公開する必要がある場合は、以下を行うだけです:
- プラグインコードを修正します
manifest.yaml
のversion
フィールドを更新します
- すべての変更をmainブランチにプッシュします
- GitHub Actionsがパッケージング、ブランチ作成、PR提出を自動的に完了するのを待ちます
実行結果
プラグインソースリポジトリのmainブランチにコードをプッシュすると、GitHub Actionsは自動的に公開プロセスを実行します:
- プラグインを
{plugin-name}-{version}.difypkg
形式で自動的にパッケージ化します - パッケージファイルをターゲットリポジトリに自動的にプッシュします
- フォークリポジトリへのマージを自動的にPRで作成します
サンプルリポジトリ
完全な設定の詳細とベストプラクティスを理解するために、サンプルリポジトリを参照してください。`