如何在Buildkite步骤中展示用户选择的BUILD_STAGE参数？

核心原因 #

Buildkite在初始化解析.buildkite.yml时就会渲染所有步骤的名称，而block步骤的参数是用户后续手动选择的，初始化阶段还不存在这个变量，所以步骤名称里的${BUILD_STAGE}会是空值。

具体解决思路 #

1. 用动态生成Pipeline的方式（最推荐）

把部署步骤放到单独脚本里，等用户选完参数后再生成这一步，就能拿到已设置的BUILD_STAGE变量。

修改你的.buildkite.yml：

steps:
  - name: "Release"
    command: ./auto/release
  
  - block: "Deploy with parameters"
    fields:
      - select: "Environment"
        key: "BUILD_STAGE"
        hint: "Which Environment do you want to deploy?"
        options:
          - label: "test"
            value: "test"
          - label: "sit"
            value: "sit"
  - wait
  - name: "Generate deploy step"
    command: ./auto/generate-deploy-step.sh

创建./auto/generate-deploy-step.sh脚本（记得加执行权限chmod +x）：

#!/bin/bash
cat << YAML | buildkite-agent pipeline upload
steps:
  - name: "Deploy app to ${BUILD_STAGE} env"
    command: ./auto/deploy
YAML

用户选完环境后，脚本会动态生成带正确环境名称的部署步骤，Buildkite会自动把这一步加入Pipeline。

2. 用命令日志补充显示（快速临时方案）

如果不想改动态Pipeline，可以在部署命令里先打印环境信息，虽然步骤名称还是空，但日志里能明确看到部署的环境：

steps:
  - name: "Release"
    command: ./auto/release
  
  - block: "Deploy with parameters"
    fields:
      - select: "Environment"
        key: "BUILD_STAGE"
        hint: "Which Environment do you want to deploy?"
        options:
          - label: "test"
            value: "test"
          - label: "sit"
            value: "sit"
  - wait
  - name: "Deploy app to [env to be set] env"
    command: |
      echo "=== Deploying app to ${BUILD_STAGE} environment ==="
      ./auto/deploy

把步骤名称改成固定提示，再在命令开头打印实际环境变量，查看日志时就能清楚知道部署目标环境。

3. 结合元数据传递（多步骤复用场景）

如果需要在多个后续步骤里复用这个参数，可以先把变量存到Buildkite元数据，再在动态步骤里读取：

修改.buildkite.yml：

steps:
  - name: "Release"
    command: ./auto/release
  
  - block: "Deploy with parameters"
    fields:
      - select: "Environment"
        key: "BUILD_STAGE"
        hint: "Which Environment do you want to deploy?"
        options:
          - label: "test"
            value: "test"
          - label: "sit"
            value: "sit"
  - wait
  - name: "Save environment to metadata"
    command: buildkite-agent meta-data set build_stage ${BUILD_STAGE}
  - name: "Generate deploy step"
    command: ./auto/generate-deploy-step.sh

更新generate-deploy-step.sh：

#!/bin/bash
BUILD_STAGE=$(buildkite-agent meta-data get build_stage)
cat << YAML | buildkite-agent pipeline upload
steps:
  - name: "Deploy app to ${BUILD_STAGE} env"
    command: ./auto/deploy
YAML

这种方式适合需要在多个后续步骤里重复使用该参数的场景。

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