Repository navigation
Document the release procedure - #33
Merged
Merged
Conversation
Spell out the steps from the version bump to the tag in CONTRIBUTING.md, including the prerelease dist-tag, the registry lag and that a version cannot be republished, and point the README's Release section at it, dropping the stale manual-first-publish paragraph. Co-Authored-By: Claude Fable 5.1 <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
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.
Why
Releasing 4.0.0 showed that the docs said only "push a tag that matches
package.json". The sequence around it, and the things that matter when it goes wrong, were not written down anywhere. The author asked to document how publishing versions works.What
CONTRIBUTING.mdnow carries the release procedure maintainers follow, and the README's Release section points at it instead of repeating a partial version with a stale paragraph about a manual first publish.Changes
CONTRIBUTING.md, Releases section rewritten as a procedure. Bump the version in the PR withnpm version --no-git-tag-version, merge, wait for CI onmaster, tag the merge commit fromorigin/master, push the tag. States what the workflow then does, that a mismatched tag fails it, that a prerelease publishes asnextand a plain version aslatest, that the registry lags by a few minutes, and that a bad release is fixed by a patch version because a published version cannot be replaced. Docs only; the author asked for it after the 4.0.0 release.README.md, Release section shortened to two sentences and the tag commands, linking the procedure, and dropping the "before the first automated release" paragraph, which no longer applies since Trusted Publishing has carried the last two releases.Testing
Not tested beyond reading; documentation only. The commands in the procedure are the ones run for the 4.0.0 release on 2026-10-20.
Risk and rollout
None.
🤖 Generated with Claude Code