chore(cli): publish toolkit versions to docs - #1944
Open
mrgrain wants to merge 3 commits into
Open
Conversation
Adds a `versions` task to the aws-cdk package that generates a versions.json describing the toolkit package versions of the current build and zips it into dist/toolkit-versions.zip, which the release workflow publishes to the docs bucket.
Contributor
Dependency ReviewThe following issues were found:
License Issues.github/workflows/release.yml
OpenSSF Scorecard
Scanned Files
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1944 +/- ##
=======================================
Coverage 91.30% 91.30%
=======================================
Files 79 79
Lines 12164 12164
Branches 1719 1719
=======================================
Hits 11106 11106
Misses 1023 1023
Partials 35 35
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds a new release artifact that publishes the CLI toolkit version information to the docs bucket, so that documentation tooling can discover which versions of the toolkit packages are currently published without querying npm.
During the
aws-cdkpackage step, a newversionstask generates aversions.jsondescribing the versions ofaws-cdk,@aws-cdk/toolkit-lib, and@aws-cdk/cloud-assembly-schemafor the current build, together with a link to each package's documentation. Versions are read from the respectivepackage.jsonfiles, which have been bumped to the released versions by the time the package step runs. The file is zipped intodist/toolkit-versions.zipand uploaded to the docs bucket by a new release job, reusing the existingS3DocsPublishingmechanism.To support this, the
S3DocsPublishingcomponent was generalized: the previousdocTypeenum only covered the two toolkit-lib documentation flavors, so it was replaced with an optionals3PathPrefix, which lets each stream choose its versioned artifact name. The credentials actions were also upgraded from v4 to v6 in passing.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license