环境变量

环境变量来源

使用环境变量

定义好变量后，可在流水线中通过${XXX}引用。变量生效逻辑如下：

• 变量优先级：步骤输出变量 > 流水线运行时输入变量 > 流水线变量 > 通用变量组。

• 同一流水线关联多个通用变量组，后关联的变量组取值为准。

以下举几个典型的使用环境变量场景，如执行命令、主机部署、镜像构建参数、配置文件参数、环境变量传递等使用环境变量场景。

执行命令使用变量

将配置文件a.conf中的 key 的参数值，从123更改为变量名称为abc的环境变量值。

在Shell命令步骤中，通过 sed -i "s/key=123/key=${abc}/g" a.conf 命令将配置文件中的参数值替换为环境变量值。

$ cat a.conf
key=123
$ sed -i "s/key=123/key=${abc}/g" a.conf
$ cat a.conf
key=abc_value

在流水线变量和缓存中，将变量 abc 的默认值设置为 abc_value。

主机部署使用变量

可以在部署脚本中直接通过${XXX}引用环境变量控制主机部署逻辑。运行流水线后，在主机部署步骤的日志中查看。运行流水线后，可在主机部署步骤的日志中查看环境变量的引用结果，确认变量值已正确传递。

镜像构建参数使用变量

镜像构建时如需使用流水线环境变量作为构建参数，则可按照以下方式进行配置。

1. 在镜像构建步骤中使用指定容器环境，在构建参数中添加自定义参数，通过${XXX}形式将环境变量赋值给构建参数。构建参数会以 --build-arg的形式传递到build命令的参数中。

在镜像构建步骤的构建参数中，添加自定义参数如 abc=${abc}，该参数将以 --build-arg 形式传递到 Docker build 命令中。

2. 在 Dockerfile 中，通过ARG argName引用变量。

FROM <base-image>
ARG argName
RUN echo $argName

配置文件参数使用变量

如果您的配置文件中某个参数，需要通过环境变量进行修改，例如：代码库配置文件a.conf中有参数username，希望用流水线的环境变量进行替换，则可按照以下方式进行配置。

1. 修改配置文件a.conf中内容username = ${abc}。

2. 将abc的参数值配置在流水线的环境变量中，默认值设置为my_name_is_hanmeimei。

3. 在流水线中添加任务，在工具中找到并添加替换文件中的环境变量 步骤，填写配置文件的源文件路径。目标文件路径非必填（如果填写了目标文件路径，则会生成一个新的配置文件；不填写则直接修改原文件）。

此处源文件路径配置为 a.conf，目标文件路径配置为 b.conf。

4. 查看修改效果如下：a.conf中的username被修改为b.conf中的my_name_is_hanmeimei。注意：因为 Flow 流水线同一个任务才会共享工作区，因此修改配置文件变量步骤需要和您后续使用配置文件的步骤放在该流水线的同一个任务中。

环境变量传递

在流水线配置页定义的环境变量为预置的固定环境变量，在流水线实际运行过程中，会出现以流水线运行时的输出定义的环境变量，并将其传递给后续的步骤或任务中使用的场景。对应场景有以下两种：

• 任务内环境变量传递：步骤一生成自定义环境变量 -> 步骤二使用。

• 任务间环境变量传递：任务一生成环境变量 -> 任务二使用。

值得注意的是，在使用不同的构建环境时需要使用不同的语法。不同构建环境的环境变量注入语法如下：默认环境使用 echo 'USER_abc=123' > .env（变量需以 USER_ 开头）；指定容器环境或默认VM环境使用 echo "yaojia_Test=myParam" >> "$FLOW_ENV"。

在任务一中通过添加步骤 > 工具 > 设置变量，将环境变量提升为流水线级别变量。

# 步骤一：注入环境变量
echo 'USER_abc=123' > .env

# 步骤二：引用环境变量
echo $USER_abc
123

# 步骤一：写入环境变量到 .env
echo 'USER_abc=123' > .env

# 步骤二：读取环境变量
echo $USER_abc
123

# 任务二执行日志
echo $USER_abc
123
# [Success]

# 步骤二执行日志
echo $yaojia_Test
myParam
# [Success]

# 任务二执行日志
echo $yaojia_Test
myParam
# [Success]