docs(release): correct the runbook's two broken commands - #811
Merged
Conversation
Both documented commands fail as written:
- `nx release patch` is rejected outright — nx.json configures git options
under release.changelog.git, and Nx refuses the top-level command when
granular git config is present. Replaced with the version/changelog
subcommands.
- `nx release changelog v0.0.2` double-prefixes the tag. releaseTagPattern
is `v{version}`, so passing `vX.Y.Z` yields a malformed `vvX.Y.Z` tag and
GitHub Release. Pass the bare version.
Also adds a lockfile check before pushing (the version step regenerates
package-lock.json, which on macOS can drop Linux swc bindings) and a
drift check, since version bumps on main don't publish and the version
on disk can match npm while the code differs.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
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.
Summary
Both commands in
docs/RELEASE.mdfail as written. I hit both while running a release.1.
nx release patchis rejected outright.nx.jsonconfigures git options underrelease.changelog.git, and Nx refuses the top-level command whenever granular git config is present:The runbook led with this as the recommended flow, and repeated it in the Dry run section. Replaced with the
version/changelogsubcommands, which do work.2.
nx release changelog v0.0.2double-prefixes the tag.releaseTagPatternisv{version}, so Nx prepends thevitself. Passingv0.0.57produced:Passing the bare
0.0.57produces the correctv0.0.57. Caught only because I dry-ran the step — following the runbook literally would have created a malformed tag and GitHub Release.Also added
package-lock.json; on macOS that can drop the Linux@next/swc-*bindings and break CI. Documents the one-liner that verifies only version lines changed.2right now, which is correct: fix(langgraph): reject non-durable client tool flushes #809 and fix(langgraph): retain client tool results across failed runs #810 landed after thev0.0.57tag and are unpublished.Note
Existing
docs/*.mdfiles use>blockquotes, not the website's<Callout>MDX component. I drafted with<Callout>, then converted — those would not have rendered on GitHub.Docs only.
🤖 Generated with Claude Code