A change log and release notes generated from pull request descriptions - #339
Merged
Merged
Conversation
…riptions Versions were tagged but never published as releases, so the change record existed only as pull request titles. Every merged pull request here carries a description written as a change note, so the notes for a version are those descriptions in order, and the change log is the same for every version at once. scripts/release-notes.mjs produces both from the tags and the gh CLI, dropping attribution trailers, and CHANGELOG.md is its output for all sixty versions to date. The README documents the release steps. Also makes the run-watch test deterministic. It slept a fixed span and asserted a count band, which is exactly the assertion that flakes on a loaded runner; it now waits for the give-up point and then proves no further polls happen.
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
1 participant
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.
Versions were tagged but never published as GitHub Releases, so the change record existed only as PR titles. Every merged PR here carries a description written as a change note, so the notes for a version are those descriptions in order, and the change log is the same for every version at once.
scripts/release-notes.mjsproduces both from the tags and the gh CLI (vX.Yfor one version,--changelogfor all), mapping squash commits to PRs by the(#N)suffix and dropping attribution trailers.CHANGELOG.mdis its output for all sixty versions to date. The README documents the release steps, and every existing tag is being published as a Release with these notes.Also makes the run-watch test deterministic: it slept a fixed span and asserted a count band, which flaked on the macOS runner; it now waits for the give-up point and then proves no further polls happen.