Add a CHANGELOG - #14
Merged
Merged
Conversation
The project went from 1.0.0 to 4.0.1 in a single day, including a rename and a package identity change. Anyone arriving cold had no way to read that story. Only 4.0.0 and 4.0.1 were ever published to npm; 1.1.0, 2.0.0 and 3.0.0 existed in the repository but were never released. Listing those as releases would misrepresent what users could actually install, so they sit under a clearly separated 'Before 4.0.0' heading, recorded because the version numbers appear in the git history. Shipped in the package too, since npm does not include CHANGELOG.md by default. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QJR2DDBimsijgYgZS3bUS8
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
2 participants
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.
The project went from 1.0.0 to 4.0.1 in a day, through a rename and a package identity change. Anyone arriving cold had no way to read that story.
Follows Keep a Changelog.
The honest part
Only 4.0.0 and 4.0.1 were ever published to npm. 1.1.0, 2.0.0 and 3.0.0 existed in the repository but were never released — I checked the registry rather than assuming:
Listing the unpublished ones as releases would misrepresent what anyone could actually have installed. So the file has two published entries with dates, and a clearly separated Before 4.0.0 section for the repository milestones — recorded because those version numbers do appear in the git history, and someone reading
git logwill meet them.That section is also where the certificate-pinning bug lives: it was found and fixed by the integration tests before the code was ever published, so it never reached a user. Filing it under a released version's "Fixed" would imply someone was affected. Nobody was.
Also
CHANGELOG.mdadded tofiles— npm does not include it by default, and it is worth having in the package for anyone reading it offline. Verified it now appears innpm pack.Version numbers reconstructed by walking
git logand readingpackage.jsonat each commit, not from memory.Generated by Claude Code