View Source Expublish.Changelog (expublish v2.7.3)

Functions to manipulate CHANGELOG.md and RELEASE.md.

Link to this section Summary

Functions

Build changelog entry title with version and ISO 8601 date.

Validate changelog setup. Returns :ok or error message.

Generate new changelog entry from RELEASE.md contents.

Link to this section Functions

Link to this function

build_title(version, options \\ %Options{}, date_time \\ nil)

View Source
@spec build_title(Version.t(), Expublish.Options.t(), nil | NaiveDateTime.t()) ::
  String.t()

Build changelog entry title with version and ISO 8601 date.

Formats current or given NaiveDateTime to ISO 8601 date string. Can be changed to date-time representation with the --changelog-date-time option.

Link to this function

remove_release_file!(version, options \\ %Options{}, file_path \\ "RELEASE.md")

View Source
@spec remove_release_file!(Version.t(), Expublish.Options.t(), String.t()) ::
  Version.t()

Removes RELEASE.md.

@spec validate(Expublish.Options.t()) :: :ok | String.t()

Validate changelog setup. Returns :ok or error message.

Link to this function

write_entry!(version, options \\ %Options{})

View Source
@spec write_entry!(Version.t(), Expublish.Options.t()) :: Version.t()

Generate new changelog entry from RELEASE.md contents.