• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1This document lists the steps that lead to a successful release of the Nix
2library.
3
4# Before Release
5
6Nix uses [cargo release](https://github.com/crate-ci/cargo-release) to automate
7the release process.  Based on changes since the last release, pick a new
8version number following semver conventions. For nix, a change that drops
9support for some Rust versions counts as a breaking change, and requires a
10major bump.
11
12The release is prepared as follows:
13
14- Ask for a new libc version if, necessary. It usually is.  Then update the
15  dependency in Cargo.toml accordingly.
16- Confirm that everything's ready for a release by running
17  `cargo release <patch|minor|major>`
18- Create the release with `cargo release -x <patch|minor|major>`
19- Push the created tag to GitHub.
20