mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-11-07 00:02:54 +08:00
docs(plugin): document auto-release workflow and zh README scaffold (SDK #68)
This commit is contained in:
@@ -20,6 +20,21 @@ lbp build
|
||||
|
||||
<img width="600" src="/images/zh/plugin/dev/dist/github_release.png" />
|
||||
|
||||
## Releaseの自動作成(GitHub Actions)
|
||||
|
||||
`lbp init` で作成されたプラグインには、GitHub Actions ワークフロー(`.github/workflows/release.yml`)が組み込まれているため、手動でビルドしてアップロードする必要はありません。
|
||||
|
||||
プラグインリポジトリを GitHub にプッシュした後、`manifest.yaml` の `version` フィールドを変更して `main` または `master` ブランチにプッシュするたびに、ワークフローが自動的に以下を実行します:
|
||||
|
||||
1. `lbp` CLI をインストールし、`lbp build` を実行してプラグインをパッケージ化;
|
||||
2. `v<version>` をタグとして GitHub Release を作成し、生成された `.lbpkg` ファイルをアップロード。
|
||||
|
||||
該当バージョンの Release が既に存在する場合、ワークフローはスキップして重複公開を回避します。リポジトリの Actions ページから手動でトリガーすることもできます(`workflow_dispatch`)。
|
||||
|
||||
<Info title="">
|
||||
このワークフローはリポジトリのデフォルトの `GITHUB_TOKEN` に依存し、`contents: write` 権限が必要です(テンプレートで宣言済み)。リポジトリの Actions が有効になっていること、`manifest.yaml` の `metadata.author`、`metadata.name`、`metadata.version` フィールドが正しく入力されていることを確認してください。Release 名と成果物のファイル名はこれらのフィールドから構成されます(`<author>-<name>-<version>.lbpkg`)。
|
||||
</Info>
|
||||
|
||||
## プラグインのインストール
|
||||
|
||||
LangBotのプラグイン管理ページで、右上隅をクリックしてGitHubインストール方法を選択します。
|
||||
|
||||
Reference in New Issue
Block a user