Skip to content

[codex] docs: clarify release flow #23

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

Closed
nahiyankhan wants to merge 1 commit into from
Closed

[codex] docs: clarify release flow #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion .changeset/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
This folder is managed by `@changesets/cli`. Use it to record release notes,
version `@anarchitecture/madrigal`, and publish the package to npm.

Common workflow:
For release-bearing PRs, add a changeset and let the generated
`chore: version packages` PR update `package.json` and `CHANGELOG.md`. Do not
manually bump versions for normal releases.

Common workflow for local testing:

```bash
pnpm changeset
Expand Down
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,16 +319,23 @@ ln -sf "$(pwd)/skills/{skill-name}/SKILL.md" ~/.claude/skills/{skill-name}/SKILL
Madrigal uses [Changesets](https://github.com/changesets/changesets) for
versioning and npm publishing.

For a release-bearing change, run:
For a release-bearing change, include a changeset in the feature or fix PR:

```bash
pnpm changeset
```

After the change lands on `main`, the `Release` GitHub Actions workflow creates
a version PR when changesets are pending. When that version PR lands, the same
workflow builds Madrigal and publishes it to npm with provenance. The workflow
expects the npm automation token in `MADRIGAL_NPM_PUBLISH_TOKEN`.
a `chore: version packages` PR when changesets are pending. When that generated
version PR lands, the same workflow builds Madrigal and publishes it to npm with
provenance. For normal releases, do not edit `package.json` versions or
`CHANGELOG.md` directly; let the generated version PR own those updates.

The direct publish from PR #21 was a bootstrap correction: `0.1.0` was already
checked in but unpublished under the corrected `@anarchitecture/madrigal` name.
Future releases should go through a pending changeset and the generated version
PR. The workflow expects the npm automation token in
`MADRIGAL_NPM_PUBLISH_TOKEN`.

Manual release commands are also available:

Expand Down
Loading