手动触发流水线

2828 字约 9 分钟

云原生构建支持在页面上配置自定义按钮来手动触发流水线，点击按钮即可执行 web_trigger 自定义事件，同时支持在页面上输入环境变量。

效果如下：

提示

目前仅支持在「代码-分支详情页」上配置自定义按钮。

自定义按钮配置

在仓库根目录下创建 .cnb/web_trigger.yml 文件来配置自定义按钮。

提示

.cnb/web_trigger.yml 不支持 include 和 imports 语法。
自定义按钮触发的事件需在 .cnb.yml 中配置，否则无法触发。

.cnb/web_trigger.yml
branch:
  # 如下按钮在分支名以 release 开头的分支详情页面显示
  - reg: ^release
    buttons:
      - name: 按钮名1
        # 如存在，则将作为流水线 title，否则流水线使用默认 title；可支持环境变量替换（仅支持替换一级，环境变量指的是当前配置的 env 和 inputs。仅支持 ${xxx} 写法。）
        description: 按钮描述
        # 触发的 CI 事件名，需要在 .cnb.yml 中配置
        event: web_trigger_one
        # 是否默认按钮
        isDefault: false
        # 权限控制，不配置则有仓库写权限的用户可触发构建
        # 如果配置，则需要有仓库写权限，并且满足 roles 或 users 其中之一才有权限触发构建
        # 注意：仅支持在页面检查 permissions 权限
        permissions:
          # roles 和 users 配置其中之一或都配置均可，二者满足其一即可
          # 角色非向上包含关系。例如如下配置，表示仅 master 或 developer 角色才有权限，owner 即使仓库权限更高，但此处无权限
          roles:
            - master
            - developer
          users:
            - name1
            - name2
        # 环境变量
        env:
          # 默认传入的环境变量，其中 key 值（a,b,c）为环境变量名，支持如下两种格式
          a: 1
          b: 2
          c:
            # 环境变量别名
            name: 变量c
            # 环境变量值
            value: 3
        # 可输入环境变量，可覆盖上述 env 的变量配置
        inputs:
          # 目前支持以下三种格式：输入框（input）、多行文本输入框（textarea）、下拉选择框（select 支持单选和多选），switch 开关（switch），radio 单选框（radio）
          # 其中 key 值（var1、var2、var3、var4、var5、var6）为环境变量名
          # inputs 也支持分组，见下方按钮二 inputs 配置
          var1:
            # 输入框
            name: 变量1
            description: 变量1描述
            placeholder: 请输入变量1
            required: true # 是否必填
            type: input
            default: 默认值1
          var2:
            # 输入框
            name: 变量2
            description: 变量2描述
            placeholder: 请输入变量2
            required: true
            type: textarea
            default: 默认值2
          var3:
            # 单选下拉选择框
            name: 变量3
            description: 变量3描述
            placeholder: 请选择变量3
            required: false
            type: select
            default: value1
            options:
              - name: 选项1
                value: value1
                description: 选项1描述
              - name: 选项2
                value: value2
                description: 选项2描述
          var4:
            # 多选下拉选择框
            name: 变量4
            description: 变量4描述
            placeholder: 请选择变量4
            required: false
            type: select
            # 是否支持多选，多选结果用分号分隔
            multiple: true
            default: value1,value2
            options:
              - name: 选项1
                value: value1
                description: 选项1描述
              - name: 选项2
                value: value2
                description: 选项2描述
              - name: 选项3
                value: value3
                description: 选项3描述
          var5:
            # switch 开关
            name: 变量5
            description: 变量5描述
            required: false
            type: switch
            default: value1
            options:
              - name: 选项1
                value: value1
                description: 选项1描述
              - name: 选项2
                value: value2
                description: 选项2描述
          var6:
            # radio 单选框
            name: 变量6
            description: 选择变量6
            required: false
            type: radio
            default: value1
            options:
              - name: 选项1
                value: value1
                description: 选项1描述
              - name: 选项2
                value: value2
                description: 选项2描述

  # 如下按钮在分支名以 dev 开头的分支详情页面显示
  - reg: ^dev
    buttons:
      - name: 按钮名2
        description: 按钮描述
        event: web_trigger_two
        inputs:
          # inputs 支持分组，如下所示，用数组格式，每个数组元素代表一个分组。
          # 分组仅在页面显示上有区别，不影响实际的环境变量传入
          - name: 分组一
            # 是否默认折叠该分组，默认为 false 不折叠
            collapsed: false
            inputs:
              # 目前支持以下三种格式：输入框（input）、多行文本输入框（textarea）、下拉选择框（select 支持单选和多选），switch 开关（switch），radio 单选框（radio）
              # 其中 key 值（var1、var2、var3、var4、var5、var6）为环境变量名
              var1:
                # 输入框
                name: 变量1
                description: 变量1描述
                placeholder: 请输入变量1
                required: true # 是否必填
                type: input
                default: 默认值1
              var2:
                # 输入框
                name: 变量2
                description: 变量2描述
                placeholder: 请输入变量2
                required: true
                type: textarea
                default: 默认值2
              var3:
                # 单选下拉选择框
                name: 变量3
                description: 变量3描述
                placeholder: 请选择变量3
                required: false
                type: select
                default: value1
                options:
                  - name: 选项1
                    value: value1
                    description: 选项1描述
                  - name: 选项2
                    value: value2
                    description: 选项2描述
          - name: 分组二
            inputs:
              var4:
                # 多选下拉选择框
                name: 变量4
                description: 变量4描述
                placeholder: 请选择变量4
                required: false
                type: select
                # 是否支持多选，多选结果用分号分隔
                multiple: true
                default: value1,value2
                options:
                  - name: 选项1
                    value: value1
                    description: 选项1描述
                  - name: 选项2
                    value: value2
                    description: 选项2描述
                  - name: 选项3
                    value: value3
                    description: 选项3描述
              var5:
                # switch 开关
                name: 变量5
                description: 变量5描述
                required: false
                type: switch
                default: value1
                options:
                  - name: 选项1
                    value: value1
                    description: 选项1描述
                  - name: 选项2
                    value: value2
                    description: 选项2描述
          - name: 分组三
            inputs:
              var6:
                # radio 单选框
                name: 变量6
                description: 选择变量6
                required: false
                type: radio
                default: value1
                options:
                  - name: 选项1
                    value: value1
                    description: 选项1描述
                  - name: 选项2
                    value: value2
                    description: 选项2描述
      - name: 按钮名3
        description: 按钮描述
        event: web_trigger_three

  # 如下自定义按钮在所有分支详情页面显示
  - buttons:
      - name: 按钮名4
        description: 按钮描述
        event: web_trigger_four
      - name: 按钮名5
        description: 按钮描述
        event: web_trigger_launch_vscode
        # 是否是启动一个云原生开发环境，如果是，则触发构建后，会直接进入云原生开发启动的 loading 页
        openWorkspace: true
      - name: 按钮名6
        # 此处是一级环境变量引用，流水线 title 为：按钮描述
        description: ${description}
        event: web_trigger_six
        env:
          description: 按钮描述
      - name: 按钮名7
        # 此处是二级环境变量引用，只替换一级，流水线 title 为：${title}
        description: ${description}
        event: web_trigger_seven
        env:
          description: ${title}
          title: 按钮描述

  # 按钮分组示例：通过 groupName 字段将按钮分组显示，不同分组之间有分割线隔开，分组名会作为标题显示
  - reg: ^feature
    buttons:
      - name: 构建分组A-按钮1
        description: 构建分组A
        event: web_trigger_group_a_1
        # 按钮分组名，相同 groupName 的按钮会分组显示，不同分组之间有分割线隔开
        groupName: 构建操作
      - name: 构建分组A-按钮2
        description: 构建分组A
        event: web_trigger_group_a_2
        groupName: 构建操作
      - name: 测试分组B-按钮1
        description: 测试分组B
        event: web_trigger_group_b_1
        groupName: 测试操作

目前仅支持配置分支详情页的自定义按钮。YAML 中键名为 branch，值为数组格式：

reg：选填，String，正则表达式，用于匹配分支名（仅匹配到的分支显示 buttons 配置的自定义按钮）。未填则匹配全部分支。
buttons：必填，Array<Button>，自定义按钮定义。Button 类型定义如下：
- name: 必填，String，自定义按钮名
- description: 选填，String，按钮描述。如存在，将作为流水线 title，否则使用默认 title；支持环境变量替换（仅支持替换一级，环境变量指当前配置的 env 和 inputs，仅支持 ${xxx} 写法）
- image: 选填，String，自定义按钮图标。只能用本仓库中当前分支的图片，填写相对仓库根目录的路径，如 .cnb/button.png
- event: 必填，String，触发的 CI 事件名，需要在 .cnb.yml 中配置。仅支持 web_trigger 自定义事件。
- isDefault：选填，Boolean，是否为默认按钮，仅支持设置一个（设置多个时取第一个）。设置默认按钮后，点击按钮直接弹出默认按钮的触发构建弹框；未设置时，点击按钮弹出包含所有自定义按钮的弹层。
- groupName: 选填，String，按钮分组名。相同 groupName 的按钮会分组显示在一起，分组名会作为标题显示在按钮上方，不同分组之间有分割线隔开。未配置 groupName 的按钮归为同一组。
- openWorkspace：选填，Boolean，是否启动云原生开发环境。开启后触发构建将直接进入云原生开发的启动页。非云开发场景请勿配置此参数。
- env: 选填，Object<String, String|EnvType>，传给 web_trigger 自定义事件流水线的默认环境变量，不支持编辑。对象键值为环境变量名；对象值支持两种格式，String 和 EnvType。EnvType 类型定义如下：
  - name: 必填，String，环境变量别名。非传给流水线的环境变量名
  - value: 必填，String，环境变量值
- permissions：选填，权限控制，满足 users 或 roles 之一即可触发构建（还需仓库写权限）。未配置时，有仓库写权限即可触发。注意：仅支持在页面检查权限。
  - users: 选填，Array<String>，用户名数组。可定义多个。
  - roles: 选填，Array<String>，仓库角色数组。可定义多种仓库角色: owner（负责人）、master（管理员）、developer（开发者）、reporter（助手）、guest（访客）。角色非向上包含，例如仅声明 master 有权限，owner 即使仓库权限更高也无效。
- inputs: 选填，Object<String, Input>，可手动输入的环境变量，对象的键值为变量名，Input 类型定义如下：
  - name：必填，String，输入选项名称，非环境变量键值，仅用于页面展示
  - description：选填，String，描述信息
  - placeholder：选填，String，输入框内提示信息。仅当 type=input 或 textarea 或 select 时有效
  - required：选填，Boolean，是否必填
  - type：选填，String，输入框类型，可选 input、textarea、select、switch、radio，默认为 input
  - default: 选填，String，默认值
  - multiple: 选填，Boolean，是否支持多选，仅当 type=select 时有效，多选结果用分号分隔。单个选项的 value 中需避免出现逗号
  - options: 选填，Array<Option>，当 type: select 或 type: switch 时的选项。Option 类型定义如下：
    - name: 必填，String，选项名
    - value: 必填，String，选项值，作为环境变量值
    - description: 选填，String，选项描述信息
  inputs 也支持分组，Array<Object>，每个数组元素是一个对象，表示一个分组，类型定义如下：
  - name: 必填，String，分组名称，非环境变量键值，仅用于页面展示
  - collapsed: 非必填，Boolean，是否默认折叠该分组，默认为 false 不折叠
  - inputs: 必填，Object<String, Input>，分组内环境变量定义，对象的键值为变量名，Input 类型定义同上方 Input类型定义。

自定义 web_trigger 流水线

.cnb/web_trigger.yml 中的自定义按钮仅支持触发 web_trigger 自定义事件，需在 .cnb.yml 中配置对应的流水线。

.cnb.yml
# 匹配以 release 开头的分支名
release*:
  # 自定义按钮可触发的事件
  web_trigger_one:
    - stages:
        - name: 输出环境变量
          script:
            - echo $a
            - echo $b
            - echo $var1
            - echo $var2
            - echo $var3

# 匹配以 dev 开头的分支名
dev*:
  web_trigger_two:
    - stages:
        - name: 执行任务
          script: echo "job"

  web_trigger_three:
    - stages:
        - name: 执行任务
          script: echo "job"

# 匹配所有分支名
"**":
  web_trigger_four:
    - stages:
        - name: 执行任务
          script: echo "job"

权限说明

仅有仓库写权限的用户可点击自定义按钮执行 web_trigger 流水线。