Skip to content

Latest commit

 

History

History
60 lines (50 loc) · 2.42 KB

RELEASE_CHECKLIST.md

File metadata and controls

60 lines (50 loc) · 2.42 KB
Raw

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, and Wix. cargo install cargo-wix

Ubuntu below shall refer to Ubuntu 16.04. Builds tend to be more forward-compatible than backwards.

Preliminary

  1. Review the commit and PR history since last release. Ensure that all relevant changes are included in CHANGELOG.md
  2. Ensure the readme and homepage website reflects API changes. This includes changing the download links to reflect the latest version.
  3. Run python update_version.py v.v.v.
  4. Update Rust tools: rustup update
  5. Run cargo test, cargo fmt
  6. Run cargo clippy -- -W clippy::pedantic -W clippy::nursery -W clippy::cargo
  7. Commit and push the repo
  8. Check that CI pipeline passed

Build binaries

  1. Run cargo build --release on Windows and Ubuntu.
  2. Run cargo deb on Ubuntu.
  3. Run cargo rpm build on Centos 7. Remove the unnecessary -1 in the filename. (This allows easy installation for Red Hat, Fedora, and CentOs. Also note that the standalone Linux binary may not work on these distros.) users, and binaries built on other OSes appear not to work on these due to OpenSSL issues.
  4. Run cargo wix on Windows.
  5. Zip the Windows .exe, along with README.md and LICENSE.
  6. Run maturin build on Windows and Ubuntu.
  7. Run snapcraft on Ubuntu.

Publish binaries

  1. Run cargo package and cargo publish (Any os).
  2. Run snapcraft login, then snapcraft push --release=stable pyflow_x.x.x_amd64.snap on Ubuntu.
  3. For the Windows and Ubuntu wheels, run twine upload (wheelname).
  4. Add a release on Github, following the format of previous releases.
  5. Upload the following binaries to the release page: zipped Windows binary (This is all Scoop needs), Linux binary, Msi, Deb, Rpm.

Note on buildling python binaries for the Pybin repo:

Windows:

Install, copy the file from Appdata/Local/programs/python, and match the filename/compression format with existing entries

Linux:

Download source. Run these:

./configure --prefix=$HOME/python_built
make
sudo make install