openzim / openzim/devdocs

Release 0.3.0

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

@benoit74 is already working on this.

Since Nov 14, 2024.

task
Dominant language
Python
Stars
9
Forks
3
PR merge metrics
No merged PRs in 30d

Description

This issue serves as a checklist for the release event.

  • Check that dependencies have been updated to latest version
  • Check that regex in devdocs hasn't changed, otherwise update it in the scraper as well
  • Commit and push these changes to a PR and then merge to main branch
  • Secure the CI is green on git main branch
  • Update Github milestone to match the issues that will be released
  • Close Github milestone
  • Adjust version in __about__.py to x.x.x
  • Update the Changelog so that it is in line with the content of Github milestone
  • Commit and push these changes to tag on Github named vx.x.x
  • Create a Github release, pointing to the tag, with the Changelog of this release, and 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/devdocs/releases and tagged latest
  • Check that version is published on Pypi at https://pypi.org/project/devdocs2zim/
  • Check that version is published on Github Container Registry at https://ghcr.io/openzim/devdocs and tagged latest
  • 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 __about__.py to x.y.z+1-dev0 (next patch version incrementaly)
  • Commit and push these changes to main Github branch
  • Inform rgaudin/benoit74 that a new release is ready to use so that they will update Zimfarm recipes
  • Advertise the new scraper release on #scrapers Slack channel

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.