如何在GitHub Action的CDK TypeScript代码中创建步骤输出？

你之前的做法没生效，是因为误将CDK的core模块和GitHub Actions的core模块混淆了——CDK代码里直接调用的core.setOutput如果是来自@aws-cdk/core，那和GitHub Actions的步骤输出完全无关。要实现需求，得让CDK代码在运行时输出符合GitHub Actions规范的内容，以下是两种可行方案：

方案一：使用GitHub Actions官方的@actions/core库 #

这是最规范的方式，借助GitHub Actions提供的Node.js库来输出步骤变量：

1. 先在CDK项目中安装依赖：

npm install @actions/core --save-dev

2. 在你的CDK TypeScript代码中引入并调用：

import * as cdk from 'aws-cdk-lib';
import * as core from '@actions/core'; // 引入GitHub Actions的core库
import { CfnAccessKey } from 'aws-cdk-lib/aws-iam';

export class YourStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // ... 你的其他CDK代码，比如定义testUser ...
    const accessKey = new CfnAccessKey(this, 'testserKey', {
      userName: testUser.userName,
    });

    // 输出到GitHub Actions步骤输出
    core.setOutput('devSecret', accessKey.attrSecretAccessKey);
    // 可选：如果是敏感密钥，添加掩码避免日志泄露
    core.setSecret(accessKey.attrSecretAccessKey);
  }
}

3. 保持你原来的GitHub Actions workflow配置不变，执行CDK deploy后，后续步骤就能通过${{ steps.run-cdk.outputs.devSecret }}读取到输出值。

方案二：直接输出符合GitHub Actions格式的字符串（无需额外依赖） #

如果不想新增依赖，可以直接在CDK代码中打印符合GitHub Actions规范的内容，GitHub会自动识别这些输出：

推荐的新格式（GitHub Actions当前标准） #

通过写入GITHUB_OUTPUT环境变量指向的文件来输出：

import * as cdk from 'aws-cdk-lib';
import { CfnAccessKey } from 'aws-cdk-lib/aws-iam';
import * as fs from 'fs';

export class YourStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // ... 你的其他CDK代码 ...
    const accessKey = new CfnAccessKey(this, 'testserKey', {
      userName: testUser.userName,
    });

    // 写入到GITHUB_OUTPUT文件
    if (process.env.GITHUB_OUTPUT) {
      fs.appendFileSync(process.env.GITHUB_OUTPUT, `devSecret=${accessKey.attrSecretAccessKey}\n`);
      // 可选：添加掩码
      console.log(`::add-mask::${accessKey.attrSecretAccessKey}`);
    }
  }
}

兼容旧格式（仍可使用但不推荐） #

直接打印::set-output指令：

// ... 你的CDK代码 ...
const accessKey = new CfnAccessKey(this, 'testserKey', {
  userName: testUser.userName,
});
console.log(`::set-output name=devSecret::${accessKey.attrSecretAccessKey}`);
// 可选：添加掩码
console.log(`::add-mask::${accessKey.attrSecretAccessKey}`);

关键注意事项 #

• 确保CDK deploy的日志会输出你的打印内容：如果CDK默认日志级别不够，可在workflow的run命令中添加--verbose参数，比如run: cdk deploy --all --require-approval=never --verbose。
• 敏感信息必须添加掩码：无论是用core.setSecret还是::add-mask::指令，避免密钥在GitHub Actions的日志中泄露。
• 输出值不能包含换行或特殊字符：如果有这类情况，需要先对值进行转义处理（比如使用encodeURIComponent）。

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