upload-plugin.md

在 BKCI 里使用商店插件

开发好插件之后，通过研发商店工作台，将插件发布到研发商店，提供给用户添加到流水线中使用。

入口

在工作台列表，点击如下入口发起发布流程：

1. 首次发布时，入口名为“上架”
2. 升级版本时，入口名为“升级”

或者在插件发布管理->版本管理界面发起发布流程：

1. 当前版本不是结束态时，这里可能的操作是：
   • 上架：首版本进入上架流程
   • 进度：进入发布流程页面
2. 最新版本是结束态时，才可以新增新版本

填写插件相关信息/上传插件发布包

上架/升级插件时，可以修改插件的基本信息，如下所示：

1. 适用 Job 类型：
   • 和流水线 Job 类型对应，请按照插件实际适用情况选择
   • 若选错，需新增版本修改
2. 发布包：
   • task.json 中的 atomCode 需和开发一个流水线插件中新增插件时填写的标识一致，否则上传会失败

当升级插件时，有三种升级模式：

1. 非兼容式升级：
   • 插件输入、输出不同或者相同输入输出但功能逻辑发生重大变更，和老版本不兼容时使用
   • 此类型版本发布后，已使用该插件的流水线不会自动升级版本，需用户手动修改版本号
   • 主版本号 +1
2. 兼容式功能更新：
   • 插件输入输出兼容旧版本，仅功能更新或新增(不影响已使用用户)时使用
   • 此类型版本发布后，已使用该插件且版本号选为[主版本.latest]的流水线自动使用新版本插件，无需手动编辑流水线
   • 次版本号 +1
3. 兼容式问题修正：
   • 插件输入输出兼容旧版本，仅做问题修正
   • 此类型版本发布后，已使用该插件且版本号选为[主版本.latest]的流水线自动使用新版本插件，无需手动编辑流水线
   • 修正号 +1

测试/发布插件

填写好信息，提交后，进入发布流程，可以测试->重新传包->测试，直至插件满足预期后，手动继续流程将插件发布到研发商店

1. 测试：点击后跳转到插件调试项目的流水线服务下，可以将当前插件添加到流水线，验证 UI、功能是否满足预期
2. 重新传包：当测试发现问题，修复后，重新上传发布包，再次进行测试
3. 继续：测试 OK，满足预期后，确认提交发布
4. 取消发布：发布过程中，随时可以终止发布

注意：当插件开发语言为 Python、Nodejs 时，对插件执行环境有一定要求，请参考第三方构建机环境准备