全部产品

步骤 yaml 描述语言

Item 属性

属性名称

含义

是否必填

默认值

哪些 Type的item 可以使用

name

作为该 item 的唯一标识,用于 step.sh 中环境变量的 key

全部

hidden

是否隐藏组件,当组件隐藏时当前组件必须有默认值 value

false

全部

type

item的不同类型决定了其展现形式。

全部

rules

该item的校验规则,比如

rules:

-required # 表示该字段是必须的

-length: # 校验输入长度

min: 4

max: 10

-unique # 整个流水线级别唯一

-regex: xxxxxx # 校验正则

true

全部

input,password

label

该 item 在表单中显示的 label

全部

links

可以在item的下方平铺展示的若干个链接,如:

links:
  - text: 帮助文档
    url: https://www.docs.com

input,select

datasource

数据源。

静态数据源的value是数组:

datasource:
  - label: 选项1
    value: value1
  - label: 选项2
    value: value2

select

showCondition

该item的显示条件,比如:

- name: package_label
   label: 包标签
   type: pipeline_global_params
   showCondition: package_type.value == "from_global"

则表示只有当另一个name为package_type 的 item 的值为 from_glob al时,该 package_label item 才会显示

所有

value

默认值

input

description

在item的右边显示一个问号,显示提示信息。

所有

Item Type列表

  • input

    普通的输入框

  • password

    一个界面现实为星号的输入框

  • textarea

    一个普通文本域

  • shell

    一个对 bash 语法展示高亮的文本域

  • select

    下拉框

  • text_label

    固定的文本,此时需要配合填写value,该值会直接显示在流水线编辑页面上,也可以在 step.sh 中使用。

  • checkbox

    一个checkbox,选中时,值为true,未选中时,值为false