summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHomu <homu@barosl.com>2016-09-08 09:53:31 +0900
committerHomu <homu@barosl.com>2016-09-08 09:53:31 +0900
commitde560749d9afa9a5fcdd12147d721cd0d7fd9ae9 (patch)
treec4214af65c1b0bea34bc96820b4d3c760c643b71
parent3612b357532bbf35ecb67470d29a185ea3ceeed2 (diff)
parent8557e9fb8c8d49fd9ae669d92d298f723d5429d6 (diff)
downloadnix-de560749d9afa9a5fcdd12147d721cd0d7fd9ae9.zip
Auto merge of #418 - kamalmarhubi:release-procedure, r=posborne
Expand on release procedure
-rw-r--r--RELEASE_PROCEDURE.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md
index 2613ce5a..80972d5b 100644
--- a/RELEASE_PROCEDURE.md
+++ b/RELEASE_PROCEDURE.md
@@ -3,16 +3,36 @@ library.
# Before Release
-The release is prepared by a commit with the following changes.
+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.
-- In CHANGELOG.md, rename the Unreleased section to the new version followed by
- the date of the release.
+The release is prepared as follows:
+
+- Make a commit with a message like "Release v0.8.3" with the following
+ changes:
+ - In `CHANGELOG.md`, rename the Unreleased section to the new version
+ followed by the date of the release.
+ - In `Cargo.toml`, update the version to the new version.
+ - In `README.md`, update the version in the Usage section to the new
+ version.
+- Make a pull request.
+- Once the PR is merged, tag the merge commit, eg `git tag v0.8.3
+ $MERGE_COMMIT_SHA1`.
+- Push the tag, eg `git push v0.8.3`.
# Create Release
+- Checkout the tag.
+- Publish to crates.io with `cargo publish`.
+
# After Release
After the release a commit with the following changes is added to the master
branch.
- Add a new Unreleased section header to CHANGELOG.md.
+- In `Cargo.toml`, update the version to the next `-dev` version, eg
+ `v0.8.4-dev`.
+- Commit with a message like "Bump to v0.8.4-dev"
+- Make a pull request.