如何在CDK CodePipeline多步骤中复用全局安装的NPM包？

每个CodeBuildStep都是独立的隔离构建环境，默认情况下synth步骤中全局安装的NPM包不会自动在后续步骤中可用——因为每个步骤运行在独立容器内，执行完毕后环境就会销毁，状态不会保留。要实现共享，有以下几种可行方案：

方案1：使用CodeBuild缓存功能 #

通过配置CodeBuild的S3或本地缓存，将NPM全局安装的目录纳入缓存范围，让后续步骤复用缓存中的包。

代码示例（S3缓存）： #

import { Bucket } from 'aws-cdk-lib/aws-s3';

// 创建缓存用的S3桶
const cacheBucket = new Bucket(this, 'NpmGlobalCacheBucket');

const pipeline = new CodePipeline(this, 'Pipeline', {
  synth: new CodeBuildStep('InstallStep', {
    commands: ['npm install -g some-package'],
    // 配置S3缓存
    cache: CodeBuildCache.s3({
      bucket: cacheBucket,
      prefix: 'npm-global-cache',
    }),
    // 指定NPM全局安装路径，确保缓存目录一致
    buildEnvironment: {
      environmentVariables: {
        NPM_CONFIG_PREFIX: { value: '/root/.npm-global' },
      },
    },
  }),
});

const initStep = new CodeBuildStep(`InitStep`, {
  commands: [
    // 将全局包的bin目录加入PATH
    'export PATH=$PATH:/root/.npm-global/bin',
    'some-package'
  ],
  // 复用同一个S3缓存
  cache: CodeBuildCache.s3({
    bucket: cacheBucket,
    prefix: 'npm-global-cache',
  }),
  buildEnvironment: {
    environmentVariables: {
      NPM_CONFIG_PREFIX: { value: '/root/.npm-global' },
    },
  },
});

方案2：将包安装到构建产物目录并传递 #

放弃全局安装，将包安装到synth步骤的输出目录，通过Pipeline的产物传递机制把包含包的目录传给后续步骤。

代码示例： #

const pipeline = new CodePipeline(this, 'Pipeline', {
  synth: new CodeBuildStep('InstallStep', {
    commands: [
      // 安装到当前目录的node_modules，而非全局
      'npm install some-package',
    ],
    // 指定输出目录包含node_modules
    primaryOutputDirectory: './',
  }),
});

const initStep = new CodeBuildStep(`InitStep`, {
  // 直接调用本地node_modules中的包
  commands: ['./node_modules/.bin/some-package'],
  // 接收synth步骤的输出产物
  input: pipeline.synthOutput,
});

方案3：使用预安装依赖的自定义CodeBuild镜像 #

制作一个预先安装好some-package的Docker镜像，推送到ECR，然后让所有需要使用该包的CodeBuildStep都使用这个自定义镜像，无需再安装。

代码示例： #

import { Repository } from 'aws-cdk-lib/aws-ecr';

// 引用ECR中的自定义镜像（需提前构建并推送）
const customBuildImage = CodeBuildImage.fromEcrRepository(
  new Repository(this, 'CustomBuildImageRepo', { 
    repositoryName: 'prebuilt-build-image' 
  }),
  'latest'
);

const pipeline = new CodePipeline(this, 'Pipeline', {
  synth: new CodeBuildStep('InstallStep', {
    commands: [], // 无需安装，镜像已包含依赖
    buildEnvironment: {
      buildImage: customBuildImage,
    },
  }),
});

const initStep = new CodeBuildStep(`InitStep`, {
  commands: ['some-package'],
  buildEnvironment: {
    buildImage: customBuildImage,
  },
});

方案对比 #

• 缓存方案：适合依赖包需要频繁更新的场景，缓存会自动同步最新版本，但首次构建仍需安装。
• 产物传递方案：适合临时或一次性的依赖共享，无需额外配置缓存或镜像，但会增加产物传递的体积。
• 自定义镜像方案：适合长期稳定的依赖，构建速度最快，但更新依赖需要重新构建并推送镜像。

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