You need to enable JavaScript to run this app.
导航
自定义变量
最近更新时间:2024.07.25 14:36:09首次发布时间:2024.03.08 11:11:09

除了预置变量外,持续交付支持自定义流水线中的变量,满足更多定制化场景。使用自定义变量前,需先创建自定义变量,然后通过$(parameters.变量名)的形式进行引用。本节为您介绍如何创建自定义变量。

背景信息

自定义变量同时支持变量和环境变量,两者都可以用来传递流水线参数,请根据实际情况选择使用变量还是环境变量。

  • 变量:一组预先定义好的键值对,在流水线实际执行前,对所有步骤输入中的变量占位符进行替换。引用方式为$(parameters.key)
  • 环境变量:一组预先定义好的键值对,在流水线实际执行的容器环境中,由 Linux 的环境变量机制完成环境变量的替换。引用方式为${key}$key

注意

环境变量不是机密的,它们的值可能会在日志中显示,不适合存储敏感信息。

前提条件

已创建流水线。具体操作可参见 创建流水线

操作步骤

  1. 进入流水线的流程编排页签。

    1. 登录 持续交付控制台
    2. 在左侧导航栏选择 工作区
    3. 单击目标工作区名称,进入当前工作区。
    4. 在左侧导航栏选择 流水线,进入流水线页面。
    5. 在流水线列表中选择目标流水线,单击 ... > 编辑,进入当前流水线的流程编排页签。
  2. 单击 变量,弹出变量设置面板。

  3. 切换至自定义变量页签,单击 添加,新增一个自定义变量。支持添加多个变量。
    alt

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

    类型

    选择变量类型。

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

    动态

    是否打开动态设置开关。

    • 开启动态设置,支持在运行流水线时修改当前变量的运行值。

      • 对于手动触发流水线,后续可在 运行流水线 面板中设置当前变量的运行值。

      • 对于自动触发流水线,后续可在对应 触发器 面板, 通过 运行时变量 参数,设置当前变量的运行值。

    • 关闭动态设置,手动/自动触发流水线时,均使用当前变量的默认值。

    环境变量

    是否设置为环境变量。

    • 开启:为环境变量,引用方式为${key}$key
    • 关闭:为变量,引用方式为$(parameters.key)

    注意

    环境变量不适合存储敏感信息。

    说明

    • 隐私设置和动态设置为互斥关系,无法同时开启。
    • 单选 变量默认开启动态设置,支持在运行流水线时选择变量的运行值。
  4. 单击 确定,完成自定义变量创建。

    说明

    自定义变量创建完成后,您便可以在流水线任意需要使用该变量的步骤中进行引用。

    alt

  5. 单击 保存,保存流水线配置。