流水线 CODEARTS PIPELINE-插件介绍:codearts-extension.json文件定义

时间：2024-07-02 11:48:25

流水线 CODEARTS PIPELINE 基础插件

codearts-extension.json文件定义

codearts-extension.json文件示例内容如下：

{
    "type": "Task",
	"name": "demo_plugin",
	"friendlyName": "示例插件",
	"description": "这是一个示例插件",
	"category": "Gate",
	"version": "0.0.2",
	"versionDescription": "0.0.1初始化版本",
	"dataSourceBindings": [],
	"inputs": [{
	    "label": "服务调用地址",
		"name": "SERVICE_URL",
		"type": "input",
		"description": "请输入服务地址url",
		"defaultValue": "",
		"required": true
	},
	{
	    "label": "调用服务的token",
		"name": "SERVICE_TOKEN",
		"type": "input",
		"description": "请输入调用服务的token",
		"defaultValue": "",
		"required": true
	}],
	"execution": {
		"type": "Shell",
		"target": "scripts/execution.sh"
	},
	"outputs": []
}

codearts-extension.json文件参数说明如下：

表1 codearts-extension.json文件参数说明
参数项	说明
type	填写固定值“Task”，标识为一个插件类型。
name	请与注册插件时页面填写的基本信息“唯一标识”字段一致。
friendlyName	请与注册插件时页面填写的基本信息“插件名称”字段一致。
category	请与注册插件时页面填写的基本信息“插件类型”字段一致，包括以下可选值： Build：对应“构建”插件类型。 Test：对应“测试”插件类型。 Gate：对应“代码检查”插件类型。 Normal：对应“通用”插件类型。 Deploy：对应“部署”插件类型。
version	插件版本，支持填写3组0-99的数字，如需新增正式版本，请修改此字段。
description	插件的描述信息。
versionDescription	此版本插件的描述信息，建议体现每个版本的差异点。
dataSourceBindings	此字段暂时未启用，请将值设置为“[]”。
inputs	插件输入内容，对应流水线页面插件展示格式，其值可在业务脚本中通过引用环境变量的方式引用。
execution	业务插件执行内容，其中type字段为业务脚本语言类型，target字段为执行文件入口，建议放在scripts文件夹下。
outputs	插件输出内容，在插件运行结束后写入此处定义值，可对应用作门禁指标metrics，不同的展示结果output。