Skip to content

chore(cli): publish toolkit versions to docs - #1944

Open
mrgrain wants to merge 3 commits into
mainfrom
mrgrain/chore/publish-cli-version-to-docs
Open

chore(cli): publish toolkit versions to docs#1944
mrgrain wants to merge 3 commits into
mainfrom
mrgrain/chore/publish-cli-version-to-docs

Conversation

@mrgrain

@mrgrain mrgrain commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

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-cdk package step, a new versions task generates a versions.json describing the versions of aws-cdk, @aws-cdk/toolkit-lib, and @aws-cdk/cloud-assembly-schema for the current build, together with a link to each package's documentation. Versions are read from the respective package.json files, which have been bumped to the released versions by the time the package step runs. The file is zipped into dist/toolkit-versions.zip and uploaded to the docs bucket by a new release job, reusing the existing S3DocsPublishing mechanism.

To support this, the S3DocsPublishing component was generalized: the previous docType enum only covered the two toolkit-lib documentation flavors, so it was replaced with an optional s3PathPrefix, which lets each stream choose its versioned artifact name. The credentials actions were also upgraded from v4 to v6 in passing.

Checklist

  • This change contains a major version upgrade for a dependency and I confirm all breaking changes are addressed
    • Release notes for the new version:

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

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.
@mrgrain
mrgrain deployed to automation September 4, 2026 11:12 — with GitHub Actions Active
@mrgrain
mrgrain deployed to automation September 4, 2026 11:12 — with GitHub Actions Active
@mrgrain
mrgrain deployed to no-approval September 4, 2026 11:12 — with GitHub Actions Active
@github-actions github-actions Bot added the p2 label Sep 4, 2026
@aws-cdk-automation
aws-cdk-automation requested a review from a team September 4, 2026 11:12
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Dependency Review

The following issues were found:
  • ✅ 0 vulnerable package(s)
  • ✅ 0 package(s) with incompatible licenses
  • ✅ 0 package(s) with invalid SPDX license definitions
  • ⚠️ 1 package(s) with unknown licenses.
See the Details below.

License Issues

.github/workflows/release.yml

PackageVersionLicenseIssue Type
aws-actions/configure-aws-credentials6.*.*NullUnknown License

OpenSSF Scorecard

PackageVersionScoreDetails
actions/aws-actions/configure-aws-credentials 6.*.* 🟢 6.2
Details
CheckScoreReason
Maintained🟢 1030 commit(s) and 7 issue activity found in the last 90 days -- score normalized to 10
Code-Review⚠️ 1Found 2/12 approved changesets -- score normalized to 1
Binary-Artifacts🟢 10no binaries found in the repo
Packaging⚠️ -1packaging workflow not detected
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
Dangerous-Workflow🟢 10no dangerous workflow patterns detected
Token-Permissions⚠️ 0detected GitHub workflow tokens with excessive permissions
Pinned-Dependencies⚠️ 1dependency not pinned by hash detected -- score normalized to 1
License🟢 10license file detected
Fuzzing⚠️ 0project is not fuzzed
Signed-Releases⚠️ -1no releases found
Security-Policy🟢 10security policy file detected
SAST🟢 10SAST tool is run on all commits
Branch-Protection🟢 8branch protection is not maximal on development and all release branches

Scanned Files

  • .github/workflows/release.yml

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.30%. Comparing base (ebf9bc5) to head (925135c).

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           
Flag Coverage Δ
suite.unit 91.30% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants