Merge pull request #1408 from pwrmiller/main

feat!: cdkCliVersion parameter renamed to cdkAssetsVersion

Author: cdklabs-automation

API.md

@@ -84,10 +84,10 @@ export interface GitHubWorkflowProps extends PipelineBaseProps {
   readonly concurrency?: github.ConcurrencyOptions;
 
   /**
-   * Version of the CDK CLI to use.
+   * Version of the [cdk-assets package](https://www.npmjs.com/package/cdk-assets) to use.
    * @default - automatic
    */
-  readonly cdkCliVersion?: string;
+  readonly cdkAssetsVersion?: string;
 
   /**
    * Indicates if the repository already contains a synthesized `cdk.out` directory, in which
@@ -204,7 +204,7 @@ export class GitHubWorkflow extends PipelineBase {
   private readonly preSynthed: boolean;
   private readonly awsCredentials: AwsCredentialsProvider;
   private readonly dockerCredentials: DockerCredential[];
-  private readonly cdkCliVersion?: string;
+  private readonly cdkAssetsVersion?: string;
   private readonly buildContainer?: github.ContainerOptions;
   private readonly preBuildSteps: github.JobStep[];
   private readonly postBuildSteps: github.JobStep[];
@@ -229,7 +229,7 @@ export class GitHubWorkflow extends PipelineBase {
   constructor(scope: Construct, id: string, props: GitHubWorkflowProps) {
     super(scope, id, props);
 
-    this.cdkCliVersion = props.cdkCliVersion;
+    this.cdkAssetsVersion = props.cdkAssetsVersion;
     this.preSynthed = props.preSynthed ?? false;
     this.buildContainer = props.buildContainer;
     this.preBuildSteps = props.preBuildSteps ?? [];
@@ -538,7 +538,7 @@ export class GitHubWorkflow extends PipelineBase {
       throw new Error('Asset Publish step must have at least 1 asset');
     }
 
-    const installSuffix = this.cdkCliVersion ? `@${this.cdkCliVersion}` : '';
+    const installSuffix = this.cdkAssetsVersion ? `@${this.cdkAssetsVersion}` : '';
     const cdkoutDir = options.assemblyDir;
     const jobId = node.uniqueId;
     const { assetId, assetManifestPath } = assets[0];

src/pipeline.ts

@@ -673,3 +673,29 @@ function wrapEnv(variable: string, value: string, cb: () => void) {
     process.env[variable] = original;
   }
 }
+
+test('pipeline with cdkAssetVersion override', () => {
+  withTemporaryDirectory((dir) => {
+    const github = new GitHubWorkflow(app, 'Pipeline', {
+      workflowPath: `${dir}/.github/workflows/deploy.yml`,
+      synth: new ShellStep('Build', {
+        installCommands: ['yarn'],
+        commands: ['yarn build'],
+      }),
+      runner: Runner.WINDOWS_LATEST,
+      cdkAssetsVersion: '4.2.0',
+    });
+
+    const stage = new Stage(app, 'MyStack', {
+      env: { account: '111111111111', region: 'us-east-1' },
+    });
+
+    new Stack(stage, 'MyStack');
+
+    github.addStage(stage);
+
+    app.synth();
+
+    expect(readFileSync(github.workflowPath, 'utf-8')).toMatchSnapshot();
+  });
+});