Repository navigation
Release v1.1.0 - #26
Merged
Merged
Conversation
Three downstream-reported bugs and the first CI workflow. No public API changed. The minor bump is for the published package layout rather than for anything a caller writes code against: lib/esm and lib/cjs now carry their own type markers, which changes how Node and bundlers classify those files. Adds CHANGELOG.md and docs/releases, neither of which existed. Prior tags carried no notes and are not back-filled.
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
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.
What changes
Bumps
package.jsonto 1.1.0 and writes the notes for it. AddsCHANGELOG.mdanddocs/releases/, neither of which existed before. No source changes, so nothing here affects the library at runtime.Once this merges,
v1.1.0gets tagged on master and the GitHub Release goes up withdocs/releases/v1.1.0.mdas its body.npm publishis a separate manual step, since the release notes are worth reading before 1.1.0 becomes the version everyone resolves to.Reviewer's guide
Release notes are read by two audiences with opposite needs, which is why there are two files rather than one. Someone upgrading wants the short answer: what broke, what got fixed, do I have to change anything. Someone three years from now bisecting a regression wants the long answer: which PR, which issue, what the actual mechanism was. A single file serves one of them badly. CHANGELOG.md is the index card, cumulative and scannable, one line per change with the issue and PR numbers. docs/releases/v1.1.0.md is the file behind the card, a paragraph per fix explaining the mechanism, and it doubles as the GitHub Release body so nobody has to keep two write-ups in sync by hand.
Read in this order:
Decision log
lib/esmandlib/cjsnow carry their owntypemarkers, which changes how Node and every bundler classify those files. That reaches further than the bugs it fixes, and a patch release is the wrong place to put it.docs/releases/outsidedocs/content/, which is the s3genContentRoot. Release notes are not doc-site pages and should not turn into one.npm publishmanual. There is no publish workflow and adding one is a separate decision about whether releases should be automated at all.Risk / blast radius
npm install notationsresolves to, and npm versions cannot be reused.//note. Documents containing//used to fail and now load, so a consumer that treated a parse failure as a signal will see behaviour change. Nothing that parsed cleanly before parses differently.Before / after
Repository contents:
CHANGELOG.mddocs/releases/v1.1.0.mdv1.1.0once taggedOut of scope