更新时间:2026-03-20 GMT+08:00
分享

配置流水线参数

YAML流水线参数分为两种类型:自定义参数和通用参数组。私密参数不支持在YAML中配置,需要转换到页面配置中进行设置。

YAML文件示例

inputs:                                                     #除私密参数之外的自定义参数
  input1:                                                   #参数名
    type: string                                            #参数类型
    default: abc                                            #默认值
    manual_override: false                                  #是否运行时设置
    description: 描述
  input2:
    type: increment                                         
    default: 1.0.0                                          
    manual_override: false                                 
    is_strict: true                                         #是否开启严格递增校验
    description: 描述
  input3:
    type: enum                                             
    default: value1
    manual_override: true                                  
    description: 描述
    values: [ "value1", "value2", "value3" ]                #枚举值
vars:
  uses:                                                     #通用参数组的名称
  - test1
  - test2
  - test3

自定义参数

自定义参数可通过 "inputs" 进行配置,目前支持字符串、自增长和枚举三种参数类型。yaml文件示例如下。

inputs:                                                     
  input1:                                                   
    type: string                                            
    default: abc                                            
    manual_override: false                                  
    description: 描述
  input2:
    type: increment                                         
    default: 1.0.0                                          
    manual_override: false                                  
    is_strict: true                                         
    description: 描述
  input3:
    type: enum                                              
    default: value1
    manual_override: true                                  
    description: 描述
    values: [ "value1", "value2", "value3" ]               
表1 参数解释

参数名

说明

inputs

用于定义自定义参数配置。

input1

自定义参数的名称,仅支持大小写英文字母、数字或下划线,不超过128个字符。

type

定义参数的类型,包含三种类型。

  • string:自定义参数为字符串类型。
  • increment:自定义参数为自增长类型。
    • is_strict:若为true,则执行流水线时会校验该参数是否严格递增。
    • latest_value:当前参数的自增长进展。
  • enum:自定义参数位枚举类型。values为枚举值列表。

default

参数的默认值。

manual_override

是否运行时设置。若为true,则支持执行流水线时修改该参数的值。

  • true:是。
  • false:否。

description

对于参数的描述。

通用参数组

vars:
  uses:                                                     #通用参数组的名称
  - test1
  - test2
  - test3
表2 参数解释

参数名

说明

vars

用于定义通用参数组配置。

uses

通用参数组的名称,仅支持大小写字母、数字或下划线,不超过128个字符。

相关文档