Releasing Instructions

This document describes steps to follow when releasing a new version of Mundane.

Update Cargo.toml with the new version number
Update boringssl/boringssl by running git submodule foreach git pull origin master
Update boringssl/boringssl.rs:

Run boringssl/bindgen.sh <major> <minor> <patch>
Run git diff to verify that all of the version numbers have been updated correctly (namely, the link attribute at the top of the file is of the form #[link(name = crypto_X_Y_Z)], and every link_name attribute is of the form #[link_name = "__RUST_MUNDANE_X_Y_Z_SYMBOL_NAME"], where X.Y.Z is the version number, and SYMBOL_NAME is the name of the symbol that the link_name attribute is attached to)
Run boringssl/test_symbol_version_name.sh <major> <minor> <patch> to verify that all of the version numbers have been updated correctly

Make sure ./test.sh passes.
Update CHANGELOG.md - move any unreleased changes into a new section for the new version.
Dry run by running cargo publish --dry-run --allow-dirty.
Commit the changes.
Once the changes have been committed, publish by running cargo publish.

Provide feedback