管道环境变量

标准环境变量

所有正在执行的管道都可以使用这些环境变量。

保留的环境变量

这些环境变量具有预定义的值，不能被覆盖。

onExecute: - add_run_variables steplet_${steplet_number}_variable=${env1}

用户自定义环境变量

中定义的自定义环境变量的配置部分的管道YAML文件。

管道

类中声明环境变量配置部分。这里声明的环境变量可用于管道中的所有步骤。

—名称:my_pipeline配置:environmentVariables: readOnly: env1: value1 env2: value2

步骤

方法中声明环境变量配置步骤在管道内的部分。来自此源的环境变量仅在声明它们的步骤中可用。

步骤:—name: step_1 type: Bash配置:environmentVariables: env1: value1 env2: value2

YAML模式参考

在声明环境变量时，遵循YAML语法约定并正确地引用和转义值以确保pipeline能够正确地解析它们是很重要的。

一般来说，YAML字符串是Unicode的，可以不加引号。然而在使用特殊字符时，需要遵循某些规则。以下字符串需要引号:

• 以特殊字符开头，例如:：, {, }, [, ], ,, &, *, #, ?, |, -, <, >, =, !, %, @, )
• 以空白字符开始或结束
• 看起来像一个数字或布尔值(123，1.23，真正的，假，零）

例子

单引号

'这个字符串'使用单引号"

双引号

"这个字符串使用\ tab"

多行字符串

多行字符串可以使用:

• 折叠方式:用大于号(>)表示，其中每个换行符转换为空格。
• 文字样式:用管道(|)表示，以保留换行符。

折叠样式(>)

文字风格(|)

转义序列

YAML使用转义序列如下:

• \ n用来表示一条新线
• \ t用于表示TAB
• \ \表示斜杠
• Bash的风格“\”用于转义作为内容一部分且不应折叠的额外空格
• 末尾的\用于表示延续标记。这对于将长字符串分成多行而不引入不必要的空白非常有用

环境变量配置

除了键值语法之外，还可以在环境变量定义下使用以下属性来增强其配置。以下属性可用于两者中声明的环境变量管道和步骤配置部分。

管道:—名称:my_pipeline配置:环境变量:readOnly: env1: value1 env2:默认:value1 description: env2描述值:—value1—value2—value3 steps:—名称:my_step类型:Bash配置:环境变量:step_env1:默认:value1描述:步骤env1描述值:—value1—value2—value3 allowCustom: true step_env2: value2执行:onExecute:—echo "test"

当你使用自定义配置触发运行， UI使用YAML文件中的配置来控制用户输入使用自定义配置运行面板:

在YAML中，如果allowCustom设为真正的，您可以为该字段输入任何值为运行定义自己的值。在上面的示例中，您可以为的输入自定义值step_env2，除了已经定义的值之外。请注意，自定义值仅对特定运行可用。

集成

使用集成的步骤可以通过环境变量访问集成的属性。环境变量的形式为:

int_ <集成名称> _ <标记>

例如，您可以访问一个的URL属性Artifactory集成命名myArtifactory通过环境变量:

$ printenv int_myArtifactory_url https://mycompany.com/artifactory/

您还可以通过使用集成的资源访问集成的属性。环境变量的形式为:

Res_ _<集成标签名称>_<标签>

例如，图像资源在其注册表标签。您可以访问Image资源所使用的Artifactory集成的URL模板如下:

$ printenv res_myImage_registry_url https://mycompany.com/artifactory/

有关更多信息，请参见管道集成．

2022世界杯阿根廷预选赛赛程

中指定资源的步骤input2022世界杯阿根廷预选赛赛程resources可以通过环境变量访问该资源的属性。环境变量的形式为:

res_ <资源名称> _ <标记>

例如，您可以访问imageName的性质图像资源模板通过环境变量:

$ printenv res_myImage_imageName jfrog.local:5000/alpine37

一些资源维2022世界杯阿根廷预选赛赛程护可以作为环境变量访问的附加属性。这些资源类型包括:

• GitRepo

欲了解更多信息，请参阅管道资源2022世界杯阿根廷预选赛赛程．

基于资源的状态

中指定的资源中添加自己的属性output2022世界杯阿根廷预选赛赛程resources使用write_output效用函数．这可以用来创建有状态的管道．

新附加的属性可以作为表单的环境变量访问res_{资源名称}_{密钥名称}．例如，下面的代码将在资源中创建三个属性模板．

write_output myImage sport="baseball" equipment="bat" field="diamond"

在步骤中指定资源时inputsource，这些属性可以作为以下环境变量访问:

$ printenv res_myImage_baseball $ printenv res_myImage_equipment bat $ printenv res_myImage_field diamond

有关运行状态的详细信息，请参见创建有状态管道．

运行状态

您的管道可以定义自己的环境变量，并将它们添加到管道的运行状态。这些将对管道运行中的所有步骤可用。

使用运行状态管理的实用程序函数将新的环境变量添加到当前运行状态。例如，下面一行在一个步骤的执行块中:

add_run_variables英雄="Superman"反派="Lex Luthor"

将创建两个环境变量，可用于管道运行的当前和所有未来步骤:

英雄超人反派莱克斯·卢瑟

有关运行状态的详细信息，请参见创建有状态管道．

管道状态

您的管道可以定义自己的环境变量，并将它们添加到管道状态。这些将适用于该管道的所有运行。

使用用于管道状态管理的实用函数将新的环境变量添加到当前运行状态。例如，下面一行在一个步骤的执行块中:

Add_pipeline_variables动物="狗"蔬菜="胡萝卜"

将创建两个环境变量，可用于定义它们的管道的所有运行:

动物狗蔬菜胡萝卜

有关管道状态的详细信息，请参见创建有状态管道．