openzim/warc2zim

Release 2.1.1

Closed this issue · 0 comments

This issue serves as a checklist for the release event.

  • Secure the CI is green on git main branch
  • Create a ZIM of the test website and confirm manually it works as expected on local kiwix-serve nightly
  • Check that dependencies have been updated to latest version (especially python-scraper lib and wombat.js)
  • Ensure there is no new release on wabac.js and more specifically a change in fuzzymatcher.js which has to be backported in warc2zim in rules/rules.yaml
  • Adjust version in src/warc2zim/__about__.py and in javascript/package.json to x.x.x
  • Update Github milestone to match the issues that will be released
  • Close Github milestone
  • Update the Changelog so that it is in line with the content of Github milestone
  • Push a tag on Github named vx.x.x
  • Create a Github release, pointing to the tag, with the Changelog of this release
  • Publish the Github release (this will trigger the CI, if the CI fails and you have to push a minor fix which does not justify to create a new version, you will have to delete the release and re-create it from scratch)
  • Check that version is published as a Github release at https://github.com/openzim/warc2zim/releases and tagged latest
  • Check that version is published on Github Container Registry at https://ghcr.io/openzim/warc2zim and tagged latest
  • Check that version is published on Pypi at https://pypi.org/project/warc2zim/
  • Create a new Github milestone with the next minor version incrementaly
  • Create a new Github issue attached to this milestone with this checklist inside
  • Create new ## [Unreleased] section in Changelog (placeholder for future entries)
  • Adjust version in src/warc2zim/__about__.py and in javascript/package.json to x.x.x to x.y.z+1-dev0 (next patch)
  • Plan to release a new Zimit version