FAQ | This is a LIVE service | Changelog

release-it job does not add a terminating newline to CHANGELOG.md

The recommended release-it configuration strips trailing newlines from the CHANGELOG.md file (along some noisy fiddling with the structure of pyproject.toml).

Example MR diff: https://gitlab.developers.cam.ac.uk/uis/devops/regent-house-ballots/ballots-webapp/-/merge_requests/6/diffs?commit_id=75fa230067fa81295b991d7d861258521f20c7f6

Pipeline failure: https://gitlab.developers.cam.ac.uk/uis/devops/regent-house-ballots/ballots-webapp/-/jobs/1204790

Specific pre-commit failure log:

fix end of files.........................................................Failed
- hook id: end-of-file-fixer
- exit code: 1
- files were modified by this hook
Fixing CHANGELOG.md

As a workaround, I can add an exception to CHANGELOG.md (see, e.g., https://gitlab.developers.cam.ac.uk/uis/devops/regent-house-ballots/ballots-webapp/-/commit/a9469e5c40e8fc8e86b6fbea1023be7b4c453254?merge_request_iid=7) but it would be nice to not have to do this.

Edited by Dr Rich Wareham