opensourcemirror
/
liquidctl
mirror of https://github.com/liquidctl/liquidctl.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
liquidctl/docs/developer/release-checklist.md

2.7 KiB
Raw Blame History

Release checklist

Prepare system

  • Ensure publishing dependencies are installed: pacman -S twine

Prepare repository

  • Update liquidctl/version.py
  • Update last update date in the man page
  • Make sure the CHANGELOG is up to date
  • Remove "N/New driver, ..." notes from the table of supported devices (and merge lines if appropriate)
  • Update the link in the README to the stable executable for Windows
  • Regenerate the udev rules: (cd extra/linux && python generate-uaccess-udev-rules.py > 71-liquidctl.rules)
  • Commit: git commit -m "release: prepare for v$VERSION"

Test

  • Run unit and doc tests: pytest

Then install locally and:

  • Run my personal setup scripts: liquidcfg && liquiddyncfg
  • Test yoda: extra/yoda --match kraken control pump with '(20,50),(50,100)' on coretemp.package_id_0 and fan with '(20,25),(34,100)' on _internal.liquid --verbose
  • Test krakenduty: extra/krakenduty-poc train && extra/krakenduty-poc status
  • Test liquiddump: extra/liquiddump | jq -c .
  • Test krakenx (git): colctl --mode fading --color_count 2 --color0 192,32,64 --color1 246,11,21 --fan_speed "(30, 100), (40, 100)" --pump_speed "(30, 100), (40, 100)"

Source distribution

  • Generate the source distribution: python setup.py sdist
  • Check that all necessary files are in dist/liquidctl-$VERSION.tar.gz and that the generated extraversion.py makes sense
  • Tag HEAD with changelog and PGP signature: git tag -as "v$VERSION"
  • Push HEAD and vVERSION tag: git push origin HEAD "v$VERSION"
  • Check all CI statuses (pytest, flake8 linting, and list --verbose)
  • Sign the source distribution: gpg --detach-sign -a "dist/liquidctl-$VERSION.tar.gz"

Binary distribution for Windows

  • Download and check the artifact built by AppVeyor (zip checksum, exe checksum, contents, and functionality)
  • Sign the artifact: gpg --detach-sign -a "dist/liquidctl-$VERSION-bin-windows-x86_64.zip"

Release

  • Upload: twine upload dist/liquidctl-$VERSION.tar.gz{,.asc}
  • Upgrade the vVERSION tag on GitHub to a release (with sdist, Windows artifact, and corresponding GPG signatures)
  • Update the HEAD changelog with the release file SHA256 sums: sha256sum dist/liquidctl-$VERSION{.tar.gz,-bin-windows-x86_64.zip} | tee "dist/liquidctl-$VERSION.sha256sums"

Post release

  • Merge the release branch into the main branch (if appropriate)
  • Update the HEAD release-checklist with this checklist
  • Update ArchLinux liquidctl-git