Repository navigation
docs(changelog): clean up changelog - #1744
Merged
Merged
Conversation
Each package's 1.0.0 section repeated every rc entry and a list of dependency bumps. It now has the package rename, one line for each breaking change or new feature since 0.x, and the changes since the package's last rc. The rc sections keep the full notes. The changeset coverage check no longer counts an edit to a package's CHANGELOG.md alone, so correcting the notes of a shipped release does not need a new release.
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 22:17 — with
GitHub Actions
Inactive
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
pranavosu
had a problem deploying
to
agent-bench
November 20, 2026 23:18 — with
GitHub Actions
Error
svidgen
previously approved these changes
Nov 20, 2026
aws-cdk-blocks ships every package's CHANGELOG.md in docs/, so the shorter changelogs change its package content.
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 23:29 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 23:29 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 23:29 — with
GitHub Actions
Inactive
pranavosu
temporarily deployed
to
agent-bench
November 20, 2026 23:29 — with
GitHub Actions
Inactive
svidgen
approved these changes
Nov 20, 2026
This branch was previously deployed
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.
Problem
The 1.0.0 release (#1738) added 10,177 lines to the 27 package changelogs. Leaving pre mode makes changesets copy every rc entry into the
1.0.0section, so each1.0.0section repeated its1.0.0-rc.*sections, plus about 3,400 "Updated dependencies" lines. The older sections have the same two problems: one long changeset is copied into every package it names, and a dependency list sits under every version. A reader who upgrades from 0.x can't find what they need, and three of the 1.0.0 GitHub Releases failed to create.Issue #, if available: none
Changes
The 27 changelogs go from 36,517 lines to 5,607.
Each package's
## 1.0.0section now has:@aws-blocks/<pkg>0.x": the rename, then one line for each breaking change or new feature (the changelog'sminorentries), with its commit hash.admin-ui,bb-authandbb-databasehad no stable release under the old name, so their first line says what they replace.create-blocks-appandcreate-blockgive the command to run in place of the old one.63e571c.Every other section:
Titles: each changelog's title is the current package name. 24 of them still had the
@aws-blocks/…name.scripts/changeset-guard.ts:verify-coverageno longer counts a change topackages/<pkg>/CHANGELOG.mdalone. Correcting the notes of a release that already shipped shouldn't need a changeset, and so a new release. A CHANGELOG edit that comes with any other change to the package still needs a changeset. This changes the release policy, so please review it separately.Changeset:
aws-cdk-blocksships every package'sCHANGELOG.mdindocs/, so this PR changes its package content. A patch changeset foraws-cdk-blockscovers that, andBlocks Package Integritypasses with it.Validation
scripts/changeset-guard.test.mjshas two new tests:node --test scripts/changeset-guard.test.mjspasses.verify-coverageon this PR reports "No publishable packages were changed".validate-structure,verify-umbrella,block-majorandnpm run check:dot-folderpass.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.