docs: drop CHANGELOG; GitHub release notes are the release record - #65
Merged
Conversation
The Unreleased section was never rolled at the v0.1.0 tag, so it mixed shipped-in-0.1.0 entries with post-tag work. Split it: 0.1.1 carries only what landed after the tag (greenfield create, RunDesired, search_path pinning, DROP NOT NULL destructive); everything older moves under 0.1.0.
New capabilities (greenfield create, RunDesired) and caller-observable behavior changes warrant a minor bump, matching spirit's release numbering.
Kiran01bm
changed the title
One record per release instead of two to keep in sync, matching how spirit and schemabot publish releases. Caller-observable changes land in each release's notes (highlights + upgrade notes).
Kiran01bm
changed the title
Kiran01bm
marked this pull request as ready for review
August 30, 2026 06:08
Kiran01bm
requested review from
JashLal,
aparajon,
eeSeeGee,
jayjanssen,
jemiahw and
morgo
as code owners
August 30, 2026 06:08
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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.
Drop the in-repo CHANGELOG; GitHub release notes become the single release record.
Why
Maintaining both a Keep-a-Changelog file and GitHub release notes means two records of the same facts that must be kept in sync — and the file already drifted once (the Unreleased section was never rolled at v0.1.0, mixing shipped and unshipped entries). spirit and schemabot both publish release notes exclusively on GitHub releases; pg-sprite follows the same pattern.
What
CHANGELOG.md. Nothing else referenced it (no CI check, no doc links).Before / after