When publishing new releases of our projects, we use PyChangelog, a Python tool that reads a github project event data through github's API and generates a changelog with sections about fixed bugs (issues with the bug tag), fixed issues, and merged PRs.
git clone https://github.com/rero/pychangelog.git
.poetry install
to install dependencies.config.ini
:
repo
: the name of the project (rero-ils
, rero-ils-ui
, sonar
, ...)from_tag
and to_tag
: Title of latest release (e.g. v1.10.0
) andv1.11.0
).poetry run ./changelog.py --token <your-github-token>
PYCHANGELOG.md
for your changelogPYCHANGELOG.md
to the top of your project's CHANGELOG.md
.CHANGELOG.md
filestale
, wontfix
or duplicate
, the generator will add it to the changelog.You need to generate a personal access token to avoid the API's limit. You can do that on https://github.com/settings/tokens.
You also need the correct permissions on the repository for which you want to read the events through the API.