Skip to content

prepare for v1 release #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aspiers merged 2 commits into from
Mar 3, 2026
Merged

prepare for v1 release #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d192e7f
chore: exit pre-release changeset mode for normal release
aspiers Mar 3, 2026
9b03d54
doc(PUBLISHING): switch to npx changeset
aspiers Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/pre.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"mode": "pre",
"mode": "exit",

Copilot AI Mar 3, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.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.

Suggested change
"mode": "exit",
"mode": "exit",
"exit": true,

Copilot uses AI. Check for mistakes.
"tag": "beta",
"initialVersions": {
"@hypercerts-org/lexicon": "0.9.0"
Expand Down
12 changes: 6 additions & 6 deletions docs/PUBLISHING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ are made.
│ │
│ feature/* ──────────────────┐ │
│ │ │ │
│ │ npm run changeset │ PR │
│ │ npx changeset │ PR │
│ │ (describe changes) │ │
│ ▼ ▼ │
│ ┌─────────┐ merge ┌──────────┐ │
│ │ commit │ ────────► │ develop │ ──► Manual publish @beta │
│ │ + .md │ └────┬─────┘ (0.9.0-beta.1) │
│ └─────────┘ │ │
│ │ PR (after: npm changeset pre exit) │
│ │ PR (after: npx changeset pre exit) │
│ ▼ │
│ ┌────────┐ │
│ │ main │ ──► Creates "Release PR" │
Expand Down Expand Up @@ -73,7 +73,7 @@ Before publishing, you need to create changesets for any user-facing
changes:

```bash
npm run changeset
npx changeset
```
Comment on lines 75 to 77

Copilot AI Mar 3, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.

This will:
Expand All @@ -95,7 +95,7 @@ but it's not necessary.

```bash
# On develop branch
npm run changeset pre exit
npx changeset pre exit
git add .changeset/pre.json
Comment on lines 96 to 99

Copilot AI Mar 3, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
git commit -m "chore: exit prerelease mode"
git push
Expand All @@ -108,7 +108,7 @@ This sets the exit intent in `pre.json`, which is required before merging to `ma
To publish a stable release to npm:

1. **If merging from `develop` → `main`:**
- Run `npm run changeset pre exit` on `develop` branch
- Run `npx changeset pre exit` on `develop` branch
- Commit and push the change
- Merge `develop` → `main` (the PR check will verify exit intent)

Expand Down Expand Up @@ -174,7 +174,7 @@ Versions are determined by Changesets:
- **Major**: Breaking changes (0.9.0 → 1.0.0)

You specify the version bump type when creating a changeset with
`npm run changeset`.
`npx changeset`.

The `prepublishOnly` script ensures types are regenerated before
publishing, so the published package always includes the latest
Expand Down