Skip to main content

Module cliff

Module cliff 

Source
Expand description

The git-cliff calls: the bumped version, the changelog, and the notes.

The engine runs the git-cliff binary and links no library. It reads the pin from the embedded versions.toml and refuses a binary at any other version, so the changelog a release writes moves only with the registry row. It never passes --bump: git-cliff proposes a number, and the engine decides it.

SATISFIES release-engine:git-cliff-runs-at-its-pin

Functions§

bumped
git-cliff’s proposal for the next version, from the landed cliff.toml and the history.
changelog
Rewrite CHANGELOG.md with tag as the newest section.
notes
Write the notes of the unreleased commits, as tag, into out. The tag does not exist yet, so the notes name it.
pin
The version versions.toml pins.
require_pin
Refuse unless the git-cliff on hand runs at the pin.