如何在Buildkite CI/CD流水线中按分支定义环境变量？

需求描述 #

需要在Buildkite流水线层面定义ENVIRONMENT环境变量，规则如下：

• 当BUILDKITE_BRANCH等于main时，ENVIRONMENT=production
• 当BUILDKITE_BRANCH不等于main时，ENVIRONMENT=staging
  同时其他流水线变量（如OTHER_VAR）需要依赖该变量，期望的伪代码如下：

env:
  ENVIRONMENT: $(if BUILDKITE_BRANCH == 'main' then "production" else "staging")
  OTHER_VAR: other-var-$ENVIRONMENT

steps:
  commands:
    - echo $ENVIRONMENT
    - echo $OTHER_VAR

可行解决方案 #

方案1：通过前置步骤写入BUILDKITE_ENV_FILE #

Buildkite顶层env字段不支持直接条件表达式，但可以利用BUILDKITE_ENV_FILE这个内置文件传递变量，后续步骤会自动加载该文件中的环境变量配置：

steps:
  - label: "初始化环境变量"
    command: |
      # 根据分支设置ENVIRONMENT
      if [ "$BUILDKITE_BRANCH" = "main" ]; then
        export ENVIRONMENT="production"
      else
        export ENVIRONMENT="staging"
      fi
      # 设置依赖ENVIRONMENT的其他变量
      export OTHER_VAR="other-var-$ENVIRONMENT"
      # 将变量写入Buildkite环境文件，供后续步骤使用
      echo "export ENVIRONMENT=$ENVIRONMENT" >> "$BUILDKITE_ENV_FILE"
      echo "export OTHER_VAR=$OTHER_VAR" >> "$BUILDKITE_ENV_FILE"
    agents:
      queue: default # 替换为你的Agent队列名称

  - label: "验证环境变量"
    command: |
      echo $ENVIRONMENT
      echo $OTHER_VAR

方案2：利用YAML锚点+分支条件拆分配置 #

如果流水线可以按分支区分执行逻辑，可通过YAML锚点复用通用步骤，同时针对不同分支设置变量：

# 定义通用步骤锚点，避免重复代码
&shared_steps
  - label: "验证环境变量"
    command: |
      echo $ENVIRONMENT
      echo $OTHER_VAR

steps:
  # 处理main分支的变量设置
  - label: "Main分支变量初始化"
    command: |
      echo "export ENVIRONMENT=production" >> "$BUILDKITE_ENV_FILE"
      echo "export OTHER_VAR=other-var-production" >> "$BUILDKITE_ENV_FILE"
    branches: "main"
    agents:
      queue: default
    <<: *shared_steps

  # 处理非main分支的变量设置
  - label: "非Main分支变量初始化"
    command: |
      echo "export ENVIRONMENT=staging" >> "$BUILDKITE_ENV_FILE"
      echo "export OTHER_VAR=other-var-staging" >> "$BUILDKITE_ENV_FILE"
    branches: "!main"
    agents:
      queue: default
    <<: *shared_steps

方案3：使用Buildkite插件实现条件变量赋值 #

部分Buildkite插件支持条件式变量设置，可在流水线初始化阶段完成变量配置，示例配置如下（需确保插件已安装）：

plugins:
  - env#v1.0.0:
      ENVIRONMENT:
        value: "production"
        if: build.branch == "main"
      ENVIRONMENT:
        value: "staging"
        if: build.branch != "main"
      OTHER_VAR: "other-var-${ENVIRONMENT}"

steps:
  - label: "验证环境变量"
    command: |
      echo $ENVIRONMENT
      echo $OTHER_VAR

内容的提问来源于stack exchange，提问作者DV82XL