Skip to content
Alex Hallam edited this page Jul 4, 2023 · 20 revisions

Release TODO

tv is getting closer to being the finished product that was envisioned from the start. I assume that when tv is "complete" releases/patches will become less frequent. This page is to be a reminder of tasks I need to do when new versions are pushed. I am making this now while the steps are fresh in my mind.

  1. Documentation checklist
    • has the version been bumped in the help section of the README
    • say what has changed in changelog.md
  2. Bump the version in Config.toml
  3. Release. Push and merge a "prep" commit before commiting
  4. git checkout main. git pull. Add a tag locally that matches the version number. Push the tag to main. (This triggers GHA) git tag 0.0.0 and git push origin 0.0.0
  5. Publish cargo publish
  6. Add Debian Release: Use cargo deb to build a debian binary (maybe add this to GHA in the future). Upload to releases page. Can install with cargo install cargo-deb
  7. Add RPM Release: Use alien --verbose --to-rpm ./target/debian/tidy-viewer_<VERSION_NUMBER>_amd64.deb to make an RPM package. The .rpm will be in tv/*.rpm
  8. brew bump-formula-pr --version=<version_number> tidy-viewer. Install here https://brew.sh/
  9. Update the homebrew tap. Get the sha256sum of the apple darwin build and change the version numbers.
  • wget https://github.com/alexhallam/tv/archive/refs/tags/<version>.tar.gz
  • sha256sum 1.4.6.tar.gz
  1. Update homebrew-core.
  • Update personal homebrew fork here. Click on fetch upstream
  • try command suggested here brew bump-formula-pr --version=1.4.6 tidy-viewer
  • Get sha256sum of file downloaded from https://github.com/alexhallam/tv/archive/refs/tags/<version>.tar.gz
  • Update the hash and the version number of the url. Push to personal homebrew then open a PR to the main homebrew.
  • Make sure that the branch is named tidy-viewer-<version> i.e tidy-viewer-1.4.6

Release notation <major>.<minor>.<patch>

Clone this wiki locally