步骤 YAML 规则

name

是

ENV_ID

参数名称。name 是当前步骤入参的唯一标识，不允许重名。 支持在 script 中通过export KEY=$(inputs.name)的形式注入当前入参。
支持英文大小写、数字、“-”中横线，长度 2~50。

displayName

是

环境

参数显示名称。用作参数名称展示，不允许为空、不允许重名。
支持中英文大小写、数字、“-”中横线，长度 2~50。

description

否

这是一段描述信息

描述信息。在 displayName 旁展示一个问号，悬浮显示描述信息。
要求 200 个字符以内，支持中英文大小写和特殊字符。

type

是

string

参数类型。可选值有：

• string：适用于 uiConfig.type 为 Input/Select/CodeEditor/Password/Text 的场景。

• array：适用于 uiConfig.type 为 CheckBoxGroup 的场景。

defaultValue

否

开发环境

默认值。

• 填写默认值时，注意必须和 type 类型匹配。type 为 string 时，defaultValue 为 string 类型的值；type 为 array 时，defaultValue 为 array 类型的值。
• 当定义了 validateRule 时，defaultValue 需符合 validateRule 规则。

required

是

true

是否必填

• true：必填。在 displayName 左侧展示小红星，保存步骤时会校验当前参数是否填写。

• false：选填。

uiConfig

否

-

前端界面的 UI 组件配置。
不设置 uiConfig 时，默认使用 Input 输入框。

type

是

Input

UI 组件类型。可选值有：

• Input：输入框。

• Select：下拉单选框。

• CheckBoxGroup：复选框。

• CodeEditor：命令行，默认支持 Bash 命令。

• Password：界面显示为星号的输入框。

• Text：固定文本，显示一段只读文本。使用固定文本时，需要配合填写 defaultValue，该值会直接显示在步骤表单中。

dataSource

否

uiConfig:
  type: CheckBoxGroup
  dataSource:
    value:
      - label: a
        value: a
      - label: b
        value: b
      - label: c
        value: c

数据源，用于定义该组件可选的值。
仅适用于 Select 和 CheckBoxGroup 组件。

validateRule

否

# 长度校验
uiConfig:
      type: Input
      validateRule:
        - max: 5
          min: 2
          message: 长度必须大于2，小于5
# 正则校验
uiConfig:
      type: Input
      validateRule:
        - pattern: ^a
          message: 必须以字母 a 开头

校验规则，当前支持长度校验和正则校验。
仅适用于 Input 和 Password 组件。

name

是

bugs

参数名称。
支持英文大小写、数字、“-”中横线，长度 2~50。

displayName

是

缺陷数

参数显示名称。用作流水线运行详情中的产物名称展示，不允许为空、不允许重名。
支持中英文大小写、数字、“-”中横线，长度 2~50。

type

是

string

参数类型，默认为 string。