流水线 CODEARTS PIPELINE-代码化新建流水线自定义插件:codearts-extension.json文件定义

时间：2024-08-02 19:34:28

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": [
        {
            "name": "samplestring",                              # 如插件业务脚本中使用${samplestring}获取运行者在流水线上配置的值
            "type": "input",                                     # 不同类型信息对应不同展示功能，可选项见下文
            "description": "Sample String",                      # input条目的描述信息，用于描述其值含义
            "defaultValue": "00",                                # 默认值，required属性为false时，如不在流水线上重新输入，则默认使用此值
            "required": true,                                    # true则流水线编辑时必须重新填值，false则不填使用默认值
            "label": "测试输入框",                                # input条目在流水线编辑页面显示的名称信息
            "validation": {
                "requiredMessage": "请输入值",                    # (可选) 如required字段为true，未填写时的提示信息
                "regex": "^[a-zA-Z0-9-_\\u4e00-\\u9fa5]{1,32}$", # (可选)可填写正则校验的内容
                "regexMessage": "类型错误"                        # (可选) 如正则校验失败的提示信息
            }
        }
    ],
    "execution": {
        "type": "Shell",
        "target": "scripts/execution.sh"
    },
    "outputs": []
}

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

表2 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。