docs: clarify release process

This commit is contained in:
Ogulcan Celik 2026-03-31 14:26:54 +03:00
parent dbb83e0f29
commit 79f5f3c2c8
1 changed files with 10 additions and 1 deletions

View File

@ -37,4 +37,13 @@ Integration tests are markdown specs in `tests/integration/specs/`. A pi agent e
## Releases
`just release 0.x.y` — bumps Cargo.toml, runs tests, commits, tags, pushes. GitHub Actions builds binaries.
Before cutting a release, draft the upcoming notes under `## Unreleased` in `CHANGELOG.md`. The release script promotes that section into the versioned entry.
Default release flow:
```bash
just check
just release 0.x.y
```
`just release 0.x.y` prepares the changelog entry, bumps `Cargo.toml`, runs tests, commits, tags, and pushes. GitHub Actions builds the binaries after the tag is pushed.