feat(pipelines): cdk-assets version is configurable (#34802)

Make it possible to configure the version of `cdk-assets` CLI used by the CDK Pipeline.

This is only useful for versions of `cdk-assets` *newer*` than `3.3.1`, as older versions have wildcard ranges in their transitive dependencies and may install different versions of packages depending on what is currently available on npmjs.com.

The first `cdk-assets` version after `3.3.1` will bundle its dependencies so that the install operation will be deterministic.

We recommend you don't use this feature and just leave it at `latest`. The bundling of dependencies of `cdk-assets` will already remove any install failures around the release time of a new SDKv3 version, that used to plague `cdk-assets` in the past.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: rix0rrr

packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline.ts

@@ -75,7 +75,7 @@ export interface CodePipelineProps {
   readonly crossAccountKeys?: boolean;
 
   /**
-   * CDK CLI version to use in self-mutation and asset publishing steps
+   * CDK CLI version to use in self-mutation step
    *
    * If you want to lock the CDK CLI version used in the pipeline, by steps
    * that are automatically generated for you, specify the version here.
@@ -97,6 +97,20 @@ export interface CodePipelineProps {
    */
   readonly cliVersion?: string;
 
+  /**
+   * CDK CLI version to use in asset publishing steps
+   *
+   * If you want to lock the `cdk-assets` version used in the pipeline, by steps
+   * that are automatically generated for you, specify the version here.
+   *
+   * We recommend you do not specify this value, as not specifying it always
+   * uses the latest CLI version which is backwards compatible with old versions.
+   *
+   * @see https://www.npmjs.com/package/cdk-assets
+   * @default - Latest version
+   */
+  readonly cdkAssetsCliVersion?: string;
+
   /**
    * Whether the pipeline will update itself
    *
@@ -403,6 +417,7 @@ export class CodePipeline extends PipelineBase {
 
   private readonly singlePublisherPerAssetType: boolean;
   private readonly cliVersion?: string;
+  private readonly cdkAssetsCliVersion: string;
 
   constructor(scope: Construct, id: string, private readonly props: CodePipelineProps) {
     super(scope, id, props);
@@ -411,6 +426,7 @@ export class CodePipeline extends PipelineBase {
     this.dockerCredentials = props.dockerCredentials ?? [];
     this.singlePublisherPerAssetType = !(props.publishAssetsInParallel ?? true);
     this.cliVersion = props.cliVersion ?? preferredCliVersion();
+    this.cdkAssetsCliVersion = props.cdkAssetsCliVersion ?? 'latest';
     this.useChangeSets = props.useChangeSets ?? true;
     this.stackOutputs = new StackOutputsMap(this);
     this.usePipelineRoleForActions = props.usePipelineRoleForActions ?? false;
@@ -881,7 +897,7 @@ export class CodePipeline extends PipelineBase {
     const script = new CodeBuildStep(node.id, {
       commands,
       installCommands: [
-        'npm install -g cdk-assets@latest',
+        `npm install -g cdk-assets@${this.cdkAssetsCliVersion}`,
       ],
       input: this._cloudAssemblyFileSet,
       buildEnvironment: {

packages/aws-cdk-lib/pipelines/test/codepipeline/codepipeline.test.ts

@@ -210,6 +210,32 @@ test.each([
   });
 });
 
+test.each([
+  [undefined, 'latest'],
+  ['9.9.9', '9.9.9'],
+])('When I request cdk-assets version %p I get %p', (requested, expected) => {
+  const pipelineStack = new cdk.Stack(app, 'PipelineStack', { env: PIPELINE_ENV });
+  const pipe = new ModernTestGitHubNpmPipeline(pipelineStack, 'Cdk', {
+    cdkAssetsCliVersion: requested,
+  });
+
+  pipe.addStage(new FileAssetApp(pipelineStack, 'App', {}));
+
+  Template.fromStack(pipelineStack).hasResourceProperties('AWS::CodeBuild::Project', {
+    Source: {
+      BuildSpec: Match.serializedJson(Match.objectLike({
+        phases: {
+          install: {
+            commands: [
+              `npm install -g cdk-assets@${expected}`,
+            ],
+          },
+        },
+      })),
+    },
+  });
+});
+
 test('CodeBuild action role has the right AssumeRolePolicyDocument', () => {
   const pipelineStack = new cdk.Stack(app, 'PipelineStack', { env: PIPELINE_ENV });
   new ModernTestGitHubNpmPipeline(pipelineStack, 'Cdk');