Versioce v2.0.0

Versioce.Changelog.Formatter.Keepachangelog (Versioce v2.0.0) 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

make_body(versions)

Generate keepachangelog body

make_footer(versions)

Generate keepachangelog footer.

make_header()

Generate keepachangelog header

Link to this section Functions

Link to this function

make_body(versions)

View Source

Specs

make_body(versions :: [Versioce.Changelog.DataGrabber.Version.t()]) ::
  {:ok, String.t()}

Generate keepachangelog body

Link to this function

make_footer(versions)

View Source

Specs

make_footer([Versioce.Changelog.DataGrabber.Version.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.

Link to this function

make_header()

View Source

Specs

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

Generate keepachangelog header