release_checklist.md

Release Checklist

This is a list of steps to complete when making a new release.

System prereqs:

• Ubuntu 16.04: sudo apt update, sudo apt install build-essential, pip3 install maturin twine, cargo install cargo-deb, sudo apt install snapcraft.
• Centos 7: yum update, yum install gcc gcc-c++ make, cargo install cargo-rpm, yum install rpm-build.
• Windows: Install Visual Studio Community.

Preliminary

1. Run python update_version.py v.v.v.
2. Update Rust tools: rustup update
3. Run cargo test, cargo fmt
4. Commit and push the repo
5. Check that CI pipeline passed

Build binaries

1. Run cargo build --release on Windows and Ubuntu.
2. Zip the Windows .exe, along with README.md and LICENSE.
3. Run maturin build on Windows and Ubuntu to build wheels.

Publish binaries

1. Run cargo package and cargo publish (Any os).
2. For the Windows and Ubuntu wheels, run twine upload (wheelname).
3. Add a release on Github, following the format of previous releases.
4. Upload the following binaries to the release page: Linux binary, Windows exe.