注册自定义插件
操作步骤
- 登录CodeArts首页。
- 单击“服务 > 扩展插件”，进入扩展插件管理平台。
- 单击
，开始注册插件。 - 填写基本信息，相关参数说明如表1所示。
- 单击“下一步”，进入“版本信息”页面，填写插件版本和版本描述 。
- 插件版本号，支持填写3组0-99的数字。
- 该页面填写的信息将作为插件版本信息展示，发布后不支持修改，请谨慎填写。
- 单击“下一步”，进入“输入配置”页面，根据需要编排组件。
插件平台支持低代码化生成前端页面，拖拽组件生成可视化表单，打通流水线上下文数据，减少插件开发成本。平台默认提供了单行输入、数字、下拉单选、下拉多选、单选框、开关、多行输入等多款组件。
将左侧组件拖拽到中间布局区域，单击具体组件，右侧区域展示组件参数配置，参数说明如下：
表2 组件参数说明 类别
参数名
说明
适用控件
基本
唯一标识
组件唯一标识，用于插件业务逻辑实现过程中获取组件输入时使用。
全部控件
组件标题
用于标识组件，该标题会展示在流水线任务编排页面。
全部控件
提示信息
组件标题旁的提示信息，如：组件含义。长度不超过1000字符。
单行输入、数字、下拉单选、下拉多选、单选框、开关、多行输入
预设提示语
组件输入框内的提示信息，如：输入规范。
单行输入
精度
设置控件数值支持的小数位数，输入范围为0~4。
数字
默认值
用于设置组件的默认值。
单行输入、数字、开关、多行输入、Metrics
校验
必填
设置控件内容是否必填，支持设置错误提示信息。
单行输入、数字、下拉单选、下拉多选、单选框、多行输入
正则校验
设置控件输入内容校验，支持设置错误提示信息。
单行输入、数字、下拉单选、下拉多选、多行输入
字符数限制
用于设置组件的最大字符数限制
多行输入
选项
自定义选项
设置控件支持的选项范围：
- 显示值：插件配置时的界面显示内容。
- 选项值：插件运行时实际下发的对应值。
除手动配置外，还支持通过以下方式设置可选范围：
- 通过接口获取选项：配置webapi以获取选项内容。单击“自定义选项”旁的
，弹出“API接口”对话框，启用后即可配置，API接口参数说明请参考表3。 - 通过上下文获取选项：数据源当前支持代码源和构建任务，分别获取流水线运行时的代码源url和当前插件之前的所有构建任务ID信息。单击“自定义选项”旁的
，弹出“上下文”对话框，启用后即可配置。
下拉单选、下拉多选、单选框
阈值
配置当前版本插件的输出指标，配置完成后， 可前往“租户设置 > 策略管理 > 规则”中 创建规则并最终应用到流水线准出条件当中。
Metrics
高级
显示
设置控件是否可见，支持配置按条件显示。
单行输入、数字、下拉单选、下拉多选、单选框、开关、多行输入
禁用
设置控件是否禁用，支持配置按条件禁用。
单行输入、数字、下拉单选、下拉多选、单选框、开关、多行输入
表3 API接口参数说明 参数项
说明
联动属性
建立其他所选组件和接口的联动关系，可以进行参数传递，当组件的值更新时，会使用新值作为参数对接口进行重新调用。
URL
仅支持HTTPS协议。
返回数据路径
使用的控件需为列表数据。如以下响应体示例的返回数据路径为“result.parameters”。
{ "result": { "total": 2, "parameters": [ { "id": 3353753, "name": "parameters01" }, { "id": 3353697, "name": "parameters02" } ] }, "status": "success" }选项值
填写返回数据路径对应列表中的字段，插件运行时实际下发的对应值。
选项名称
填写返回数据路径对应列表中的字段，插件配置时的界面显示内容。
远程搜索
开启后，可添加远程搜索字段，使用插件时在输入框中填写值，会使用所填的值作为远程搜索字段的值对接口进行重新调用。
- 单击“下一步”，进入“插件编排”页面，可添加“下载制品产物”插件和“执行Shell”插件。
- 单击“下一步”，进入“输出信息”页面，单击“新增配置”，即可新增一条输出信息，包括output和metric两种类型。
- output：结合Shell命令用于数据输出。
- metric：用于输出指标解析，输出信息可以在规则中通过该插件进行引用，并最终应用到流水线。
- 配置完成后，单击“发布草稿”或“发布”，完成插件注册流程。
当前插件平台支持发布草稿和正式发布功能。
