如何通过AWS GitHub连接器为CDK传递分支上下文值？

以下是几种无需在代码中硬编码环境变量的可行方法：

1. 通过GitHub Actions传递分支信息 #

在GitHub Actions工作流文件（如.github/workflows/cdk-deploy.yml）中，直接提取当前分支名作为环境变量传给CDK命令：

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: 配置Node.js环境
        uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm install
      - name: CDK部署
        env:
          CDK_ENV: ${{ github.ref_name }}
        run: cdk deploy --all

随后在CDK代码中读取该环境变量：

const envName = process.env.CDK_ENV || 'dev'; // 设置兜底默认值
// 根据envName配置对应环境的资源

2. 使用CDK上下文参数 #

在流水线执行CDK命令时，通过-c参数传递分支对应的环境标识，无需硬编码：
比如在流水线的构建步骤中执行：

cdk deploy --all -c env=${BRANCH_NAME}

在CDK代码中通过上下文获取该值：

const envName = this.node.tryGetContext('env') || 'dev';
// 基于envName配置资源

这种方式也支持本地调试，比如本地测试dev环境可执行：cdk synth -c env=dev

3. 通过AWS CodePipeline变量传递（适用于CodePipeline流水线） #

如果你的CDK流水线基于AWS CodePipeline构建，可在源阶段获取分支名，再通过流水线变量传递到后续阶段：

• 在GitHub源阶段配置中，启用变量输出，将分支名设为变量（如BranchName）
• 在CodeBuild构建阶段的命令里，引用该变量作为CDK的环境参数：

cdk deploy --all -c env=$(echo $CODEBUILD_SOURCE_VERSION | cut -d'/' -f3)

也可直接在CodeBuild项目的环境变量配置中添加CDK_ENV，值设为$(echo $CODEBUILD_SOURCE_VERSION | cut -d'/' -f3)（CODEBUILD_SOURCE_VERSION格式为refs/heads/dev，截取后得到dev）

4. 利用CDK环境对象拆分栈 #

如果CDK应用按环境拆分栈，可在流水线中根据分支名指定CDK的环境参数：
针对dev分支执行：

cdk deploy --app "npx ts-node bin/app.ts" --env account=123456789012 --env region=us-east-1 --env name=dev

在CDK代码中从环境对象读取标识：

import { App, Environment } from 'aws-cdk-lib';

const app = new App();
const env = app.node.tryGetContext('env') as Environment & { name: string };
new MyStack(app, `MyStack-${env.name}`, { env: { account: env.account, region: env.region } });

以上方法均无需在CDK代码中硬编码环境变量，完全通过外部传递获取分支对应的环境标识，适配dev和prod分支的流水线需求。

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