Skip to content

Commit a0b2198

Browse files
patrickomaticclaude
andcommitted
Document release process in CLAUDE.md
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 9c3c0d6 commit a0b2198

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,14 @@ Run all tests with `cargo test`. There are three test suites:
5555

5656
Add a test for every new parser feature or key mapping. Integration tests should assert on specific keys at known positions in the example keymap.
5757

58+
## Releasing
59+
60+
1. Bump `version` in `Cargo.toml`.
61+
2. Verify everything is green: `cargo test && cargo clippy --all-targets -- -W clippy::pedantic -D warnings`
62+
3. Commit the version bump and push to `main`.
63+
4. Run `make release` — this creates a `vX.Y.Z` git tag and pushes it to origin, which triggers the CI release workflow (`cargo-dist`) to build platform binaries and create a GitHub Release.
64+
5. Run `cargo publish` — publishes the crate to crates.io. This step is not automated by CI and must be run manually.
65+
5866
## Key mapping conventions
5967

6068
QMK and ZMK use different names for the same physical keys. The canonical mapping lives in `src/codes.rs`. Notable differences:

0 commit comments

Comments
 (0)