Versioce.Changelog.Formatter.Keepachangelog (Versioce v1.1.2) View Source

Keepachangelog formatter, Versioce.Config.Changelog.formatter/0

Formats data obtained from Versioce.Config.Changelog.datagrabber/0 into a Keepachagelog format.

Link to this section Summary

Functions

Generate keepachangelog body

Generate keepachangelog footer.

Generate keepachangelog header

Link to this section Functions

Specs

make_body(versions :: Versioce.Changelog.DataGrabber.Versions.t()) ::
  {:ok, String.t()}

Generate keepachangelog body

Specs

make_footer(Versioce.Changelog.DataGrabber.Versions.t()) ::
  {:ok | :error, String.t()}

Generate keepachangelog footer.

Requires the optional dependency git_cli. Can be skipped by setting Versioce.Config.Changelog.git_origin/0 to nil.

Specs

make_header() :: {:ok, String.t()}

Generate keepachangelog header