docs(changelog): backfill 0.4.0, 0.5.0, and 0.5.1 - #184
Open
abhinav-phi wants to merge 2 commits into
Open
Conversation
COMPATIBILITY.md names the changelog as the surfacing mechanism for breaking changes, but entries stopped at 0.3.5. Sections are drafted strictly from the commits inside each release tag range (612a4d0..v0.4.0, v0.4.0..v0.5.0, v0.5.0..v0.5.1): the public API surface (mex-memory#44), the compatibility contract and trace field (mex-memory#45), and the package.json-derived --version fix (mex-memory#48). Where a fact was ambiguous (the npm rename's commit sits in the 0.4.0 range but the 0.3.5 notes already summarize it), the entry references the existing section rather than double-claiming. Maintainer review against the actual release notes is welcome — that is what the issue asked for. Resolves mex-memory#50
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.
Resolves #50.
What
Three new changelog sections, inserted chronologically between the existing
0.6.1and0.3.5entries, in the established Keep-a-Changelog style:--versionhard-coded-to-0.3.5 bug and its runtime fix frompackage.json(Fix hard-coded CLI version + add regression test #48), CLI option-parsing test coverage (test(cli): add CLI-level coverage for log and timeline option parsing #47), docs.EventEntry.tracefield (feat: compatibility contract, trace field, git-install ergonomics #45), with an explicit Compatibility note that the additive field requires no migration.exportsfield (export field configured by exposing a stable public API surface for mex-agent #44), plus a Compatibility pointer for the npm rename.Method (and the issue's maintainer-input note)
The issue asked contributors to write and the maintainer to supply facts. I drafted strictly from the commits inside each release tag range (
612a4d0..v0.4.0,v0.4.0..v0.5.0,v0.5.0..v0.5.1), reading the referenced PRs (#44, #45, #48, #47) for accurate descriptions. Two judgment calls worth review:--verbose, Nix flake, tool-agnostic sync) predate the v0.3 release commit and appear to ship within the 0.3.x line, so they are not attributed to 0.4.0. If any of them actually first shipped in 0.4.0, say the word and I'll move them.Compatibility-relevant items are called out explicitly, which is what COMPATIBILITY.md requires of this file.