You need to enable JavaScript to run this app.
导航

流水线变量组

最近更新时间2024.03.08 11:11:09

首次发布时间2024.03.08 11:11:09

流水线变量组是一组用户自定义的流水线全局变量。流水线变量组支持跨工作区或流水线使用,可以避免用户在多条流水线重复定义和维护相同的变量,提升变量的可复用性,减少配置成本。本文为您介绍流水线变量组相关操作。

注意

拥有 CPAdminAccess 权限的账号可创建/编辑/删除流水线变量组。

创建流水线变量组

  1. 登录 持续交付控制台

  2. 在左侧导航栏选择 全局配置 > 流水线变量组

  3. 在流水线变量组页面,单击 创建流水线变量组

  4. 在创建变量组页面,按要求填写以下参数。
    alt

    • 变量组配置
    配置项说明
    变量组名称自定义变量组名称,允许重名。变量组名称用于流水线引用时筛选变量组。

    变量组 ID

    填写变量组 ID,同一账号下不允许重复。系统已提供默认 ID,支持修改。

    注意

    变量组 ID 是变量组的唯一标识,创建后不可更改。

    描述填写变量组的备注信息,可以为空。
    共享范围选择当前变量组的共享工作区范围。仅选中工作区下的流水线可关联该变量组。

    变量配置

    配置当前变量组的变量。支持最多添加 100 个变量。
    单击 + 添加变量,在弹出添加变量对话框中,按下表要求配置变量。

    • 变量配置
    配置项说明
    参数输入自定义变量的名称,同一条流水线内名称唯一。建议避免与预置变量重名。

    类型

    选择变量类型。

    • 字符串:变量是一个字符串,由用户自行输入默认值。
    • 单选:变量是一个单选值,选项由用户自行输入,可将其中一个选项设置为默认值。
    描述填写当前变量的备注信息,可以为空。
    隐私开启隐私设置后,变量的默认值将展示为***。当变量为不希望其他用户可见的敏感信息时(例如账号密码),可开启隐私设置。隐私变量不支持修改名称和默认值。

    动态

    是否打开动态设置开关。

    • 开启动态设置,支持在运行流水线时修改当前变量的运行值。
      • 对于手动触发流水线,后续可在 运行流水线 面板中设置当前变量的运行值。
      • 对于自动触发流水线,后续可在对应 触发器 面板, 通过 运行时变量 参数,设置当前变量的运行值。
    • 关闭动态设置,手动/自动触发流水线时,均使用当前变量的默认值。

    注意

    • 隐私设置和动态设置为互斥关系,无法同时开启。
    • 单选 变量默认开启动态设置,支持在运行流水线时选择变量的运行值。
  5. 所有变量配置完成后,单击 确认

    说明

    变量组创建完成后,可在目标流水线的变量页面,关联变量组。关联变量组后,方可在流水线的各步骤中引用变量组中的变量。

查看变量组

支持查看变量组中的变量详情,支持快速新增/修改/删除变量。

  1. 在流水线变量组页面,可查看所有变量组信息。

    alt

  2. 单击目标变量组名称,可查看当前变量组详情。

  3. 在变量组详情页面,支持快速新增/修改/删除变量。

编辑变量组

支持修改变量组名称、描述、共享的工作区范围,支持新增/编辑/删除变量组中的变量。

注意

请慎重修改共享的工作区范围。删除工作区将导致工作区中已关联变量组的流水线运行异常。

  1. 在流水线变量组页面,选择目标变量组,单击操作列的 编辑
  2. 在编辑变量组页面,根据需要修改对应的配置项。
  3. 单击 确认,完成修改。

删除变量组

警告

  • 删除变量组前,请先解除与该变量组关联的流水线。
  • 删除变量组会导致已关联变量组的流水线运行异常,请谨慎操作!
  1. 在流水线变量组页面,选择目标变量组,单击操作列的 删除
  2. 在弹出的二次确认框中,输入变量组名称。
  3. 单击 确定,删除变量组。