Files
cnb/workflow/manual.md
2025-09-14 21:39:22 +08:00

3.9 KiB
Raw Permalink Blame History

手动触发流水线

.cnb/web_trigger.yml

# .cnb/web_trigger.yml
branch:
  # 如下按钮在分支名以 release 开头的分支详情页面显示
  - reg: "^release"
    buttons:
      - name: 按钮名1
        # 如存在,则将作为流水线 title否则流水线使用默认 title
        description: 按钮描述
        event: web_trigger_one # 触发的 CI 事件名
        # 权限控制,不配置则有仓库写权限的用户可触发构建
        # 如果配置,则需要有仓库写权限,并且满足 roles 或 users 其中之一才有权限触发构建
        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 开关
          # 其中 key 值var1、var2、var3、var4、var5为环境变量名
          var1:
            # 输入框
            name: 变量1
            description: 输入变量1
            required: true # 是否必填
            type: input
            default: 默认值1
          var2:
            # 输入框
            name: 变量2
            description: 输入变量2
            required: true
            type: textarea
            default: 默认值2
          var3:
            # 单选下拉选择框
            name: 变量3
            description: 输入变量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
            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描述

  # 如下按钮在分支名以 dev 开头的分支详情页面显示
  - reg: "^dev"
    buttons:
      - name: 按钮名2
        description: 按钮描述
        event: web_trigger_two
      - name: 按钮名3
        description: 按钮描述
        event: web_trigger_three

  # 如下自定义按钮在所有分支详情页面显示
  - buttons:
      - name: 按钮名4
        description: 按钮描述
        event: web_trigger_four