summaryrefslogtreecommitdiff
path: root/RELEASE_PROCEDURE.md
blob: b8cfcd81d0ff344c521e66f391733dd6780044b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
This document lists the steps that lead to a successful release of the Nix
library.

# Before Release

Nix uses [cargo release](https://github.com/crate-ci/cargo-release) to automate
the release process.  Based on changes since the last release, pick a new
version number following semver conventions. For nix, a change that drops
support for some Rust versions counts as a breaking change, and requires a
major bump.

The release is prepared as follows:

- Ask for a new libc version if, necessary. It usually is.  Then update the
  dependency in Cargo.toml accordingly.
- Confirm that everything's ready for a release by running
  `cargo release --dry-run <patch|minor|major>`
- Create the release with `cargo release <patch|minor|major>`