openzim / openzim/python-scraperlib

Release 5.5.0

Open
#309 0 comments 0 reactions 1 assignee View on GitHub

@benoit74 is already working on this.

Since May 28, 2026.

task
Dominant language
Python
Stars
31
Forks
27
Avg merge
3d 7h
Merged PRs (30d)
2

Description

This issue serves as a checklist for the release event.

  • Secure the CI is green on git main
  • Check that dependencies ranges are ok, upgrade if needed (especially wombat.js in openzim.toml)
  • Ensure there is no new release on wabac.js and more specifically a change in fuzzymatcher.ts which has to be backported in rules/rules.yaml or a change in jsrewriter.ts which has to be backported in src/zimscraperlib/rewriting/js.py
  • Adjust version in src/zimscraperlib/__about__.py to x.x.x 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/python-scraperlib/releases and tagged Latest
  • Check that version is published on Pypi at https://pypi.org/project/zimscraperlib/
  • Create a new Github milestone with the next version incrementaly (a priori a minor one)
  • 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/zimscraperlib/__about__.py and in javascript/package.json to x.y.z+1-dev0(next patch a priori )
  • Inform #scrapers channel on Slack about the new version

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.