feat: record CLI version in manifest package #184

rix0rrr · 2025-03-03T12:34:19Z

Record the current CLI version in the manifest package when we release the manifest.

This by itself will not trigger a new release of the cloud-assembly-schema package, so the version only gets recorded (and published!) when there is a new version of cloud-assembly-schema to publish anyway, and the version will only be displayed back to the user if there is an incompatibility of the major version number.

That means we won't necessarily show the lowest possible CLI version number when the user needs to upgrade, but we'll show a valid CLI version number that will definitely support the given manifest.

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

Record the current CLI version in the manifest package when we release the manifest. This will have the effect of recording the CLI version that supports a given manifest version.

codecov-commenter · 2025-03-03T12:41:47Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.09%. Comparing base (a6d4516) to head (9214af2).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #184      +/-   ##
==========================================
- Coverage   85.36%   85.09%   -0.27%     
==========================================
  Files         207      207              
  Lines       35816    35837      +21     
  Branches     4663     4625      -38     
==========================================
- Hits        30575    30497      -78     
- Misses       5084     5190     +106     
+ Partials      157      150       -7

Flag	Coverage Δ
suite.unit	`85.09% <100.00%> (-0.27%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

iliapolo · 2025-03-03T12:55:28Z

projenrc/insert-task-step.ts

+    const releaseTask = this.project.tasks.tryFind(this.props.taskName);
+    if (!releaseTask) {
+      throw new Error(`Did not find task ${this.props.taskName}`);
+    }
+
+    // Find the bump task, and do the CLI version copy straight after
+    const bumpIx = releaseTask.steps.findIndex(s => s.exec === this.props.beforeExec);
+    if (bumpIx === -1) {
+      throw new Error(`Did not find step: ${this.props.beforeExec}`);
+    }
+
+    releaseTask.steps.splice(bumpIx, 0, ...this.props.insertSteps);


Variable names here are not reflecting the generic task

packages/@aws-cdk/cloud-assembly-schema/lib/manifest.ts

iliapolo · 2025-03-03T13:05:58Z

.projenrc.ts

+  insertSteps: [
+    { exec: 'ts-node projenrc/copy-cli-version-to-assembly.task.ts' },
+  ],
+  beforeExec: 'yarn workspaces run build',


I suggest making the necessary changes to InsertTaskStep so that invoking it eventually looks like this:

Suggested change

beforeExec: 'yarn workspaces run build',

afterExec: 'yarn workspaces run bump',

Since the bump task is our "dependency" here.

I had that first but I find a "before" much more natural for an "insert" operation.

Also, yes it has to be after bump, but it also equally has to be before build, so both make sense.

I had that first but I find a "before" much more natural for an "insert" operation.

hh so call it AppendTaskStep :)

Its fine. just a personal preference.

iliapolo · 2025-03-03T13:28:53Z

.projenrc.ts

@@ -374,11 +375,24 @@ new JsiiBuild(cloudAssemblySchema, {
 (() => {
  cloudAssemblySchema.preCompileTask.exec('tsx projenrc/update.ts');

+  // This file will be generated at release time. It needs to be gitignored or it will
+  // fail projen's "no tamper" check, which means it must also be generated every build time.
+  cloudAssemblySchema.preCompileTask.exec('[[ -f cli-version.json ]] || echo \'{ "version": "" }\' > cli-version.json');


Can we not call the same copy-cli-version-to-assembly.task.ts script and have it create the empty file in case the version is 0.0.0? Just trying to minimize bash.

projenrc/insert-task-step.ts

…ersioun

mrgrain · 2025-03-07T11:20:01Z

projenrc/copy-cli-version-to-assembly.task.ts

@@ -0,0 +1,24 @@
+import { promises as fs } from 'fs';


just FYI, not sure which is better

Suggested change

import { promises as fs } from 'fs';

import * fs from 'fs/promises';

Signed-off-by: github-actions <[email protected]>

### Issue # (if applicable) N/A ### Reason for this change This upgrade is supposed to be done as part of #34362. But the `@aws-cdk/cloud-assembly-schema` upgrade requires a manual update to the unit test so I am isolating this upgrade to this PR. `v41.2.0` introduced a new line in the manifest file (PR: aws/aws-cdk-cli#184), hence, the unit test was failing. ### Description of changes Upgraded `@aws-cdk/cloud-assembly-schema` to `v41.2.0` and updated unit test. ### Describe any new or updated permissions being added None ### Description of how you validated changes Ran the build locally and no longer see the unit test failing ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

rix0rrr added 2 commits March 3, 2025 13:03

feat: record CLI version in manifest package

ca3acf4

Record the current CLI version in the manifest package when we release the manifest. This will have the effect of recording the CLI version that supports a given manifest version.

Tweaks

001385b

rix0rrr had a problem deploying to integ-approval March 3, 2025 12:34 — with GitHub Actions Failure

rix0rrr requested a review from a team March 3, 2025 12:34

aws-cdk-automation requested a review from a team March 3, 2025 12:34

github-actions bot added the p2 label Mar 3, 2025

aws-cdk-automation enabled auto-merge March 3, 2025 12:34

Do correct synthesis

34c5b78

rix0rrr had a problem deploying to integ-approval March 3, 2025 13:01 — with GitHub Actions Failure

Manifest can contain an additioanl version or not, I don't care

4bda3d6

rix0rrr had a problem deploying to integ-approval March 3, 2025 13:05 — with GitHub Actions Failure

iliapolo reviewed Mar 3, 2025

View reviewed changes

esliiiiiiiiiiiiiint

722830b

rix0rrr had a problem deploying to integ-approval March 3, 2025 13:17 — with GitHub Actions Failure

Generic

9de66a9

rix0rrr had a problem deploying to integ-approval March 3, 2025 13:17 — with GitHub Actions Failure

iliapolo reviewed Mar 3, 2025

View reviewed changes

projenrc/insert-task-step.ts Outdated Show resolved Hide resolved

rix0rrr added 2 commits March 5, 2025 20:54

bumpIx => stepIx

0f587a4

Simplify

6ce4429

rix0rrr had a problem deploying to integ-approval March 5, 2025 20:13 — with GitHub Actions Failure

rix0rrr added 2 commits March 5, 2025 21:14

Simplify!

9fdecb5

Run projen

6276a49

rix0rrr had a problem deploying to integ-approval March 5, 2025 20:14 — with GitHub Actions Failure

Update projen

7139cda

rix0rrr had a problem deploying to integ-approval March 5, 2025 20:23 — with GitHub Actions Failure

rix0rrr added 2 commits March 7, 2025 11:42

Merge remote-tracking branch 'origin/main' into huijbers/insert-cli-v…

006785d

…ersioun

projen

bbc36e9

rix0rrr had a problem deploying to integ-approval March 7, 2025 10:43 — with GitHub Actions Failure

Reset yarn.lock

fb1a1dd

rix0rrr had a problem deploying to integ-approval March 7, 2025 11:16 — with GitHub Actions Failure

Undo package.json updates

a556593

rix0rrr temporarily deployed to integ-approval March 7, 2025 11:17 — with GitHub Actions Inactive

mrgrain reviewed Mar 7, 2025

View reviewed changes

mrgrain approved these changes Mar 7, 2025

View reviewed changes

chore: self mutation

df00209

Signed-off-by: github-actions <[email protected]>

aws-cdk-automation had a problem deploying to integ-approval March 7, 2025 11:29 — with GitHub Actions Failure

chore: self mutation

6e4ace3

Signed-off-by: github-actions <[email protected]>

aws-cdk-automation temporarily deployed to integ-approval March 7, 2025 11:42 — with GitHub Actions Inactive

aws-cdk-automation had a problem deploying to run-tests March 7, 2025 12:16 — with GitHub Actions Failure

aws-cdk-automation temporarily deployed to run-tests March 7, 2025 12:16 — with GitHub Actions Inactive

rix0rrr added the pr/exempt-integ-test Skips the integ test steps if set. label Mar 7, 2025

Merge branch 'main' into huijbers/insert-cli-versioun

9214af2

aws-cdk-automation added this pull request to the merge queue Mar 7, 2025

Merged via the queue into main with commit ef550a0 Mar 7, 2025
11 checks passed

aws-cdk-automation deleted the huijbers/insert-cli-versioun branch March 7, 2025 13:32

samson-keung mentioned this pull request May 6, 2025

chore: upgrade @aws-cdk/cloud-assembly-schema to v41.2.0 aws/aws-cdk#34369

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: record CLI version in manifest package #184

feat: record CLI version in manifest package #184

Uh oh!

rix0rrr commented Mar 3, 2025

Uh oh!

codecov-commenter commented Mar 3, 2025 •

edited

Loading

Uh oh!

iliapolo Mar 3, 2025

Uh oh!

Uh oh!

iliapolo Mar 3, 2025 •

edited

Loading

Uh oh!

rix0rrr Mar 3, 2025

Uh oh!

iliapolo Mar 3, 2025

Uh oh!

iliapolo Mar 3, 2025

Uh oh!

Uh oh!

mrgrain Mar 7, 2025

Uh oh!

Uh oh!

Uh oh!

	beforeExec: 'yarn workspaces run build',
	afterExec: 'yarn workspaces run bump',

	import { promises as fs } from 'fs';
	import * fs from 'fs/promises';

feat: record CLI version in manifest package #184

feat: record CLI version in manifest package #184

Uh oh!

Conversation

rix0rrr commented Mar 3, 2025

Uh oh!

codecov-commenter commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

iliapolo Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iliapolo Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rix0rrr Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

iliapolo Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

iliapolo Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mrgrain Mar 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Mar 3, 2025 •

edited

Loading

iliapolo Mar 3, 2025 •

edited

Loading