This document describes steps to follow when releasing a new version of Mundane.
Cargo.toml
with the new version number#![doc(html_root_url = ...)]
attribute in src/lib.rs
to use the new version numberboringssl/boringssl
by running git submodule foreach git pull origin master
boringssl/boringssl.rs
:boringssl/bindgen.sh <major> <minor> <patch>
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)boringssl/test_symbol_version_name.sh <major> <minor> <patch>
to verify that all of the version numbers have been updated correctlyboringssl/test_symbol_conflict.sh
script, and ensure that it passes../test.sh
passes.CHANGELOG.md
- move any unreleased changes into a new section for the new version.cargo publish --dry-run --allow-dirty
.cargo publish
.