自动发布插件

背景

当插件贡献者需要严肃更新 已被其他用户使用的 Dify 插件 时,流程通常非常繁琐:贡献者需要先修改插件源码并更新版本号,将更改推送到插件源码仓库,并在 fork 的 dify-plugin 仓库中创建新分支。随后,贡献者需要手动打包插件并上传打包文件,再创建 PR 合并到原始 dify-plugin 仓库。这个过程必须在每次插件代码变更时重复,非常耗时低效。

为了简化这一流程,我们构建了基于 GitHub Actions 的自动化工作流 Plugin Auto-PR。借助这个工具,插件贡献者可以一键完成插件打包、分支推送以及 PR 创建。

概念简介

GitHub Actions

GitHub Actions 是 GitHub 提供的内置 CI/CD 服务,可以自动化各种构建、测试和部署任务。

运行原理:当触发条件(如 push 代码)满足时,GitHub 会自动分配虚拟机运行你的工作流。所有操作都在 GitHub 云端完成。

Workflow

免费额度

  • 公共仓库:无限制

  • 私有仓库:每月 2000 分钟

Plugin Auto-PR

运行原理

  1. 当你推送代码到插件源码仓库的 main 分支时,触发工作流

  2. 工作流从 manifest.yaml 文件中读取插件信息

  3. 自动打包插件为 .difypkg 文件

  4. 将打包文件推送到你 fork 的 dify-plugins 仓库中

  5. 创建新分支并提交更改

  6. 自动创建 PR 请求合并到上游仓库

环境准备

仓库要求

  • 你已拥有自己的插件源码仓库(例如:your-name/plugin-source

  • 你已拥有自己的 fork 插件仓库(例如:your-name/dify-plugins

  • 你的 fork 仓库中已有插件目录结构:

权限要求

此工作流需要适当的权限才能正常运行:

  • 你需要创建一个有足够权限的 GitHub Personal Access Token (PAT)

  • 该 PAT 必须有权向你的 fork 仓库推送代码

  • 该 PAT 必须有权向上游仓库创建 PR

参数与配置项说明

必要参数

插件自动发布工作流需要你正确配置以下关键元素:

manifest.yaml 文件:这是整个自动化流程的核心配置源。你需要确保以下字段正确无误:

  • name:插件名称(将用于生成包名和分支名)

  • version:版本号(每次更新时需要递增)

  • author:GitHub 用户名(用于确定目标仓库路径)

PLUGIN_ACTION Secret:你需要在插件源码仓库中正确设置此密钥。

  • 值要求:必须是具有足够权限的个人访问令牌(PAT)

  • 权限要求:能够推送分支到你的 fork 仓库,能够创建 PR 到上游仓库

自动生成的参数

工作流会自动处理以下内容,无需手动干预:

  • GitHub 用户名:从 manifest.yamlauthor 字段读取

  • 作者文件夹名称:与 author 字段保持一致

  • 插件名称:从 manifest.yamlname 字段读取

  • 分支名称:bump-{插件名}-plugin-{版本号}

  • 打包文件名:{插件名}-{版本号}.difypkg

  • PR 标题和内容:基于插件名称和版本自动生成

安装配置步骤

1

准备仓库

确保你已经 fork 了官方的 dify-plugins 仓库,并且有自己的插件源码仓库。

2

配置 Secret

导航到你的插件源码仓库,点击 Settings > Secrets and variables > Actions > New repository secret,创建 GitHub Secret:

  • 名称填写: PLUGIN_ACTION

  • 值填写: 拥有目标仓库(your-name/dify-plugins)写入权限的 GitHub Personal Access Token (PAT)

Create Secrets
3

创建工作流文件

在仓库中创建 .github/workflows/目录,并在此目录中创建名为 plugin-publish.yml 的文件,再将以下内容复制到该文件中:

4

更新 manifest.yaml

确保 manifest.yaml 文件正确设置以下字段:

使用指南

初次使用流程

首次设置自动发布工作流时,需要完成以下步骤:

  1. 确保你已经 fork 了官方的 dify-plugins 仓库

  2. 确保你的插件源码仓库结构正确

  3. 在插件源码仓库中设置 PLUGIN_ACTION Secret

  4. 创建工作流文件 .github/workflows/plugin-publish.yml

  5. 确保 manifest.yaml 文件中的 nameauthor 字段正确配置

后续更新流程

设置完成后,每次需要发布新版本时,只需:

  1. 修改插件代码

  2. 更新 manifest.yaml 中的 version 字段

Release
  1. 将所有更改推送到 main 分支

  2. 等待 GitHub Actions 自动完成打包、分支创建和 PR 提交

执行效果展示

当你推送代码到插件源码仓库的 main 分支时,GitHub Actions 将自动执行发布流程:

  • 自动打包插件为 {plugin-name}-{version}.difypkg 格式

  • 自动将打包文件推送到目标仓库

  • 自动创建 PR 合并到 fork 仓库

Outcome

示例仓库

你可以参考示例仓库,了解完整的配置细节和最佳实践。

Last updated