docs: add empty CHANGELOG.md placeholder - #16
Merged
Conversation
Makes the CHANGELOG.md link added to README.md (in the sibling PR) resolve to a real file instead of a 404, ahead of the first real release-please run creating it for real. Verified this is safe by reading release-please's actual updater source (updaters/changelog.js in the npm package): content is coerced with `content || ''`, and empty string is falsy, so a 0-byte file takes the exact same code path as a genuinely absent file - clean header + first entry, nothing demoted or duplicated. Any non-empty placeholder text, by contrast, survives the bootstrap but gets pushed below the first release entry as an orphaned, permanently-demoted sub-heading - confirmed from the same source, not worth risking. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
An empty placeholder resolves the dead link but throws away real information for no reason - this repo's tags and commit history already have it. Backfilled v0.1 through v0.5 as ## [x.y] - date entries (matching release-please's own heading level and version- number-detecting regex), sourced from each tag's actual commit range and, for v0.3-v0.5, condensed from the existing README sections. Verified against the real release-please Changelog updater (not just traced by hand) with this exact file content and a realistic v0.5.1 entry: the new entry inserts cleanly at the top, backfilled entries follow untouched in correct chronological order, nothing demoted or duplicated - because these use the ## [x.y] heading level release- please's own versionHeaderRegex already recognizes as prior entries, unlike arbitrary prose which gets demoted a level and pushed below the first real entry. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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.
Makes the CHANGELOG.md link added to README.md (#15) resolve to a real file instead of a 404, ahead of the first real release-please run creating it for real.
Verified this is safe by reading release-please's actual updater source (
updaters/changelog.jsin the npm package): content is coerced withcontent || '', and an empty string is falsy, so a 0-byte file takes the exact same code path as a genuinely absent file — clean header + first entry, nothing demoted or duplicated. Any non-empty placeholder text, by contrast, survives the bootstrap but gets pushed below the first release entry as an orphaned, permanently-demoted sub-heading — confirmed from the same source, not worth risking.No conflict with #15 (different file) — can merge in either order.
Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com