A collection of release tools used for Koha
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tomas Cohen Arazi 070d4722ed Issue #29: Add missing deps 4 weeks ago
bin Issue #23 - Use .mailmap from Koha instead of dev_map.yaml 2 months ago
etc Replace koha-patches with koha-devel 2 months ago
lib/Koha Remove warning for Koha translators 2 months ago
.gitignore Issue #22: Add an initial Dockerfile 4 weeks ago
.gitlab-ci.yml Issue #22: Use CI_COMMIT_SHA for images versions 4 weeks ago
Dockerfile Issue #29: Add missing deps 4 weeks ago
README.md Issue #26 - Remove unused and obsolete scripts/files 2 months ago
cpanfile Issue #29: Add missing deps 4 weeks ago
roll_release.sh Adding a branch parameter 10 years ago


Koha release tools

The release tools repository contains a collection of scripts to aid release mantainers and release managers in their tasks during their tenure in their respective roles.


Simply clone this repository on your development environment and copy the etc/user.example file to etc/user.yaml and update it to reflect your own details.


The most commonly used scripts can be found within the bin/ directory, but they are generally written to be run from within your koha source clone repository.


Used to check for new authors and update bugzilla prior to pushing your branch.

The script should be run from within your koha source directory.

~/release-tools/bin/koha-push updatebz ~/release-tools/bin/koha-push updatebz --range HASH..HEAD ~/release-tools/bin/koha-push updatebz --range HASH..HEAD

Upon execution it will walk through all commits that appear in your local branch but do not yet appear upstream. It will update etc/sponsor_map.yaml (from release_tools repo) and docs/contributors.yaml (from Koha repo). The script will then mark the relevant bugs as 'Pushed to X', add the relevant version to the versions released box and add your configured thankyou comment to the bug.


Used to build the release notes and report release information.

The script should be called from within your koha source directory.

~/release-tools/bin/koha-release v19.11.00..HEAD info ~/release-tools/bin/koha-release v19.11.00..HEAD notes ~/release-tools/bin/koha-release v19.11.00..HEAD notes --silent ~/release-tools/bin/koha-release v19.11.00..HEAD html misc/release_notes/release_notes_19_11_01.html

Upon execution it will walk through all commits in your given range and generate a set of release notes from their content sourcing data from the commits, bugzilla and the translation site. It will interactively ask you about author details should it find a commit with an unrecognised author, unless the --silent parameter is passed.

  • The notes command will output a markdown file.
  • The html command will read in the aforementioned markdown file and general an html file.

Koha Logo