本文档由 AI 自动翻译。如有任何不准确之处,请参考 英文原版。
背景
手动更新一个其他人正在使用的插件十分繁琐:修改代码、提升版本号、推送更改、创建分支、打包文件、提交 PR,每次发布都要重来一遍。 Plugin Auto-PR 是一个 GitHub Actions 工作流,可自动完成整个流程。一次推送即可打包插件并提交市场 PR,让你专注于开发。概念
GitHub Actions
GitHub Actions 用于在 GitHub 中自动化开发任务。当被触发时(例如代码推送),它会在基于云的虚拟机中运行你的工作流,处理从构建到部署的所有环节。
- 公开仓库:无限制。
- 私有仓库:每月 2000 分钟。
Plugin Auto-PR
该工作流会执行以下步骤:- 当你将代码推送到插件源代码仓库的主分支时触发。
- 从
manifest.yaml文件读取插件信息。 - 将插件打包为
.difypkg文件。 - 将打包后的文件推送到你 fork 的
dify-plugins仓库。 - 创建新分支并提交更改。
- 创建 PR 以合并到上游仓库。
前提条件
仓库
- 你自己的插件源代码仓库(例如
your-name/plugin-source)。 - 你自己 fork 的插件仓库(例如
your-name/dify-plugins)。 - fork 仓库中已就位的插件目录结构:
权限
创建一个 GitHub 个人访问令牌(PAT),使其能够将代码推送到你 fork 的仓库,并向上游仓库创建 PR。参数和配置
设置要求
自动发布需要两项准备就绪。manifest.yaml 文件驱动整个自动化流程:
name:你的插件名称(影响包名和分支名)。version:语义版本号(每次发布时递增)。author:你的 GitHub 用户名(决定仓库路径)。
PLUGIN_ACTION secret 保存凭据:
- 值:一个具有足够权限的个人访问令牌(PAT)。
- 权限:能够将分支推送到你 fork 的仓库,并向上游仓库创建 PR。
自动生成的参数
设置完成后,工作流会为你推导出以下参数:- GitHub 用户名:从
manifest.yaml的author字段读取。 - 作者文件夹名称:与
author字段一致。 - 插件名称:从
manifest.yaml的name字段读取。 - 分支名称:
bump-{plugin-name}-plugin-{version}。 - 包文件名:
{plugin-name}-{version}.difypkg。 - PR 标题和内容:根据插件名称和版本生成。
分步指南
1
准备仓库
确保你已 fork 官方的
dify-plugins 仓库,并拥有自己的插件源代码仓库。2
配置 Secret
在你的插件源代码仓库中,前往 Settings > Secrets and variables > Actions > New repository secret,创建一个 secret:
- 名称:
PLUGIN_ACTION - 值:一个对目标仓库(
your-name/dify-plugins)具有写入权限的 GitHub 个人访问令牌(PAT)

3
创建工作流文件
在你的仓库中创建
.github/workflows/ 目录,添加一个名为 plugin-publish.yml 的文件,并将下方的工作流粘贴进去。总体来说,该工作流会在每次推送到 main 时运行,下载 Dify 插件 CLI,根据 manifest 打包插件,检出你 fork 的 dify-plugins 仓库,并向 langgenius/dify-plugins 提交一个包含新 .difypkg 的 PR。完整工作流 YAML
完整工作流 YAML
4
更新 manifest.yaml
确保以下字段正确设置:
使用指南
首次设置
在首次自动发布之前,请确认:- 你已 fork 官方的
dify-plugins仓库。 - 你的插件源代码仓库结构正确。
- 插件源代码仓库中已设置
PLUGIN_ACTIONsecret。 - 工作流文件
.github/workflows/plugin-publish.yml已存在。 manifest.yaml中的name和author字段配置正确。
后续更新
设置完成后,发布新版本的步骤:- 修改代码。
-
更新
manifest.yaml中的version字段。
- 将所有更改推送到主分支。
- 等待 GitHub Actions 完成打包、分支创建和 PR 提交。
结果
当你将代码推送到插件源代码仓库的主分支时,GitHub Actions 会自动执行发布流程:- 以
{plugin-name}-{version}.difypkg格式打包插件。 - 将打包后的文件推送到目标仓库。
- 创建 PR 以合并到 fork 仓库。
