Expand description
Harvest a CHANGELOG from a repository’s Git history.
Two passes: git-harvest scan harvests a branch’s structured commits
into a RON fragment, and git-harvest assemble merges the fragments into
a new section of the RON CHANGELOG. git-harvest init writes a fresh
CHANGELOG to start from, and git-harvest render exports it as Markdown.
Structs§
- Assemble
Arguments - The arguments of
git-harvest assemble. - Changelog
- The whole CHANGELOG, as read from and written to
CHANGELOG.ron. - Cli
- Harvest a CHANGELOG from a repository’s Git history.
- Configuration
- The harvest configuration.
- Entry
- One line of a CHANGELOG: the change described, and the commit it was harvested from.
- Fragment
- The changes harvested from one branch, written to
changelog.d/. - Init
Arguments - The arguments of
git-harvest init. - Render
Arguments - The arguments of
git-harvest render. - Scan
Arguments - The arguments of
git-harvest scan. - Section
- One section of the CHANGELOG: the changes of a single version.
Enums§
- Command
- The tasks
git-harvestcan perform. - Grammar
- How a commit subject encodes the bucket a change belongs to.
- Renderer
- The shape the assembled CHANGELOG is rendered in for readers.
Functions§
- run
- Run
git-harvestwith its arguments already parsed.