如何在CDK Pipeline自定义CodeBuildStep中复用依赖与合成模板？

核心思路是利用CDK Pipeline原生的Artifact传递机制，而非单独配置CodeBuild缓存——因为Synth步骤和自定义步骤是独立的CodeBuild项目，默认不共享缓存，而Pipeline的Artifact传递是官方设计的依赖复用方式，更可靠高效。

具体实现步骤 #

• 自定义CodeBuildStep直接引用Synth步骤的输出Artifact，无需重新执行npm ci和cdk synth
• 步骤里的命令直接使用已生成的cdk.out模板目录和已安装的node_modules依赖

代码示例 #

假设你已有基础Pipeline定义：

import { CodePipeline, CodePipelineSource, CodeBuildStep } from 'aws-cdk-lib/pipelines';
import { Stack, Stage } from 'aws-cdk-lib';

const pipeline = new CodePipeline(this, 'MyPipeline', {
  synth: new CodeBuildStep('SynthStep', {
    input: CodePipelineSource.gitHub('owner/repo', 'main'),
    commands: ['npm ci', 'npx aws-cdk synth'],
  }),
});

添加自定义步骤时，直接指定input为pipeline.synth（Synth步骤的输出Artifact）：

// 添加自定义阶段和步骤
pipeline.addStage(new Stage(this, 'CustomActionStage', {
  stageName: 'RunCustomActions',
})).addPost(new CodeBuildStep('CustomScriptStep', {
  input: pipeline.synth,
  commands: [
    // 直接使用已有的依赖和模板，无需重复安装/合成
    'npx my-custom-tool --template-path cdk.out/MyStack.template.json',
    'node scripts/validate-template.js',
  ],
}));

额外优化：缩小传递的Artifact体积 #

如果你的自定义步骤只需要合成后的CloudFormation模板（cdk.out目录），不需要node_modules，可以在Synth步骤中指定primaryOutputDirectory，只传递必要的文件：

const synthStep = new CodeBuildStep('SynthStep', {
  input: CodePipelineSource.gitHub('owner/repo', 'main'),
  commands: ['npm ci', 'npx aws-cdk synth'],
  primaryOutputDirectory: 'cdk.out', // 仅输出cdk.out目录
});

const pipeline = new CodePipeline(this, 'MyPipeline', {
  synth: synthStep,
});

// 自定义步骤仅接收cdk.out
pipeline.addStage(...).addPost(new CodeBuildStep('CustomStep', {
  input: synthStep,
  commands: ['aws cloudformation validate-template --template-body file://cdk.out/MyStack.template.json'],
}));

为什么之前的缓存方案无效？ #

CodeBuild的缓存是单构建项目级别的，Synth步骤和自定义步骤属于不同的CodeBuild项目，默认不会共享缓存目录。而Pipeline的Artifact传递是跨步骤的标准化数据传递方式，是CDK Pipeline设计时就支持的依赖复用方案，稳定性和兼容性更好。

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