GitHub Action：如何仅在满足条件时设置Job的environment

核心结论 #

将输入参数的默认值设为空字符串，调用时传入具体环境名称是可行的，但空字符串直接赋值给environment会触发错误，需通过条件判断规避。

具体实现方案 #

在可重用工作流中定义带默认空字符串的输入参数，通过条件判断仅在参数非空时配置environment字段：

# 可重用工作流 reusable_workflow.yml
on:
  workflow_call:
    inputs:
      env_name:
        type: string
        default: ""  # 默认设为空字符串

jobs:
  test_workflow:
    runs-on: ubuntu-latest
    # 仅当输入参数非空时，添加environment配置
    ${{ if ne(inputs.env_name, '') }}:
      environment: ${{ inputs.env_name }}
    steps:
      - uses: actions/checkout@v3

调用时按需传入环境名称即可，不需要时可省略参数（自动使用默认空字符串）：

# 调用端工作流
jobs:
  call-reusable:
    uses: your-username/your-repo/.github/workflows/reusable_workflow.yml@main
    with:
      env_name: "EXAMPLE"  # 需要关联环境时传入

空字符串的后果 #

• 如果直接给environment赋值空字符串（不通过条件判断），GitHub Actions会判定为无效配置，触发类似Invalid environment name: name cannot be empty的错误，导致job执行失败。
• 通过上述条件判断逻辑，当输入为空字符串时，environment字段不会被加入job配置，此时job不关联任何环境，可正常执行，也不会触发环境的保护规则。

参考文档（翻译自GitHub官方内容） #

在GitHub Actions中为作业使用环境

环境是GitHub仓库中用于描述部署目标的资源，比如production、staging或development。你可以为作业配置环境，以利用环境的保护规则和机密。当作业关联到环境时，必须遵守该环境设置的所有保护规则才能继续执行。如果未配置环境，作业将直接执行，不会应用任何环境相关的限制。

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