本文为您介绍自定义步骤 YAML 中 Inputs 参数和 Outputs 参数的编写规则。
Inputs 用于配置步骤输入信息,支持配置多条步骤入参。下表为您介绍每条步骤入参的参数含义和规则。
名称 | 是否必填 | 示例值 | 说明 |
---|---|---|---|
name | 是 | ENV_ID | 参数名称。name 是当前步骤入参的唯一标识,不允许重名。 支持在 script 中通过 |
displayName | 是 | 环境 | 参数显示名称。用作参数名称展示,不允许为空、不允许重名。 |
description | 否 | 这是一段描述信息 | 描述信息。在 displayName 旁展示一个问号,悬浮显示描述信息。 |
type | 是 | string | 参数类型。可选值有:
|
defaultValue | 否 | 开发环境 | 默认值。
|
required | 是 | true | 是否必填
|
uiConfig | 否 | - | 前端界面的 UI 组件配置。 |
名称 | 是否必填 | 示例值 | 说明 |
---|---|---|---|
type | 是 | Input | UI 组件类型。可选值有:
|
dataSource | 否 |
| 数据源,用于定义该组件可选的值。 |
validateRule | 否 |
| 校验规则,当前支持长度校验和正则校验。 |
Outputs 用于配置步骤输出信息,支持配置多条步骤出参。下表为您介绍每条步骤出参的参数含义和规则。
说明
Outputs 产物支持被下游任务引用,详情可参见 通过自定义步骤 output 传递流水线产物。
名称 | 是否必填 | 示例值 | 说明 |
---|---|---|---|
name | 是 | bugs | 参数名称。 |
displayName | 是 | 缺陷数 | 参数显示名称。用作流水线运行详情中的产物名称展示,不允许为空、不允许重名。 |
type | 是 | string | 参数类型,默认为 string。 |
description | 否 | 这是一段描述信息 | 描述信息。在 displayName 旁展示一个问号,悬浮显示描述信息。 |
defaultValue | 否 | 1 | 默认值。 |
下文为您展示各 UI 组件及校验规则的 YAML 示例。
name: field1 displayName: 输入框 type: string defaultValue: custom step required: true uiConfig: type: Input
name: field2 displayName: 选择框 type: string defaultValue: b required: true uiConfig: type: Select dataSource: value: - label: a value: a - label: b value: b
name: field3 displayName: 复选框 type: array required: true defaultValue: - b uiConfig: type: CheckBoxGroup dataSource: value: - label: a value: a - label: b value: b - label: c value: c
name: field4 displayName: 命令行 type: string defaultValue: echo 'custom step' required: true uiConfig: type: CodeEditor
name: field5 displayName: 密码框 type: string defaultValue: required: true uiConfig: type: Password
name: field6 displayName: 文本 type: string defaultValue: 这是只读的文本 required: true uiConfig: type: Text
- name: field1 displayName: 输入框 type: string defaultValue: aaaa required: true uiConfig: type: Input validateRule: - max: 5 min: 2 message: 长度必须大于2,小于5
- name: field1 displayName: 输入框 type: string defaultValue: aaaa required: true uiConfig: type: Input validateRule: - pattern: ^a message: 必须以字母 a 开头