Conversation
The command `npm changeset pre exit` in the diagram was incorrect and would fail. Also, npx guarantees to use the versions from package.json, so `npx changeset` is fine and more convenient to type than `npm run changeset`.
|
| Name | Type |
|---|---|
| @hypercerts-org/lexicon | Patch |
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
|
Caution Review failedThe pull request is closed. ℹ️ Recent review infoConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughUpdated the changeset pre-release mode from "pre" to "exit" in configuration, and replaced all npm-based changeset command invocations with npx-based equivalents throughout publishing documentation. No functional logic changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Prepares the repository for a v1/stable release by updating maintainer publishing guidance and marking the Changesets prerelease state as exited.
Changes:
- Update publishing documentation to use
npx changesetcommands. - Set
.changeset/pre.jsonprerelease mode to"exit".
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/PUBLISHING.md | Updates the documented Changesets commands used during the release flow. |
| .changeset/pre.json | Switches Changesets prerelease state from pre to exit to support stable release. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| npm run changeset | ||
| npx changeset | ||
| ``` |
There was a problem hiding this comment.
Docs now instruct running npx changeset / npx changeset pre exit, but the repo already exposes a changeset npm script (package.json) and the CI/workflows currently tell maintainers to run npm run changeset .... This inconsistency can confuse maintainers and lead to following the wrong instructions; either switch the docs back to npm run changeset or update the referenced workflows/messages to match npx changeset consistently.
| @@ -1,5 +1,5 @@ | |||
| { | |||
| "mode": "pre", | |||
| "mode": "exit", | |||
There was a problem hiding this comment.
.changeset/pre.json is set to { "mode": "exit" }, but the PR-check/release workflows currently verify exit intent by grepping for "exit": true. With this file shape, merges to main will fail the check even though prerelease mode is exited. Update the workflow logic to check for "mode": "exit" (or adjust pre.json to the exact format the workflows expect) so CI and Changesets agree on the exit signal.
| "mode": "exit", | |
| "mode": "exit", | |
| "exit": true, |
| ```bash | ||
| # On develop branch | ||
| npm run changeset pre exit | ||
| npx changeset pre exit | ||
| git add .changeset/pre.json |
There was a problem hiding this comment.
This section instructs npx changeset pre exit, but CI/workflows and other repo tooling currently reference npm run changeset pre exit as the canonical command. Consider aligning the docs with the existing npm script (or update the workflow messages/scripts for consistency) to avoid maintainers following conflicting instructions.
Summary by CodeRabbit
Documentation
Chores