cry/nixide
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
nixide/doc/maintainers/release.md
Robert Hensing b8c741dfe9 Document release process in full 
Adopted the complete workflow from the HCI Effects cargo publish
documentation rather than referencing it, making the steps explicit
and self-contained.
2026-01-13 18:50:29 +01:00

1 KiB
Raw Blame History

Release process

This project uses simple tags, that trigger a release of all crates using Hercules CI. Based on the HCI Effects cargo publish workflow.

Steps

  1. Create a release branch
  2. Decide the version bump (patch for fixes, minor for features, major for breaking changes)
  3. Update CHANGELOG.md: make sure the Unreleased section is up to date, then change it to the new version and release date
  4. Open a draft release PR and wait for CI to pass
  5. Create and push a tag matching the version
  6. Add a new Unreleased section to CHANGELOG.md
  7. Bump version in all Cargo.toml files to the next patch version (e.g., 0.2.0 → 0.2.1) and run cargo update --workspace to update Cargo.lock, so that cargo publish --dry-run passes on subsequent commits
  8. Merge the release PR

Dissatisfied with the coarse grained release process? Complain to @roberth and he'll get it done for you.