GitOps.Changelog (Git Ops v2.11.0)

View Source

Functions for writing commits to the changelog, and initializing it.

Summary

Functions

initial_contents()
initialize(path, opts \\ [])
render(original_file_contents, commits, last_version, current_version, opts \\ [])

The updated changelog contents and the new entry, without touching the filesystem.

write(path, commits, last_version, current_version, opts \\ [])

Functions

initial_contents()

@spec initial_contents() :: String.t()

initialize(path, opts \\ [])

@spec initialize(String.t(), Keyword.t()) :: :ok

render(original_file_contents, commits, last_version, current_version, opts \\ [])

@spec render(String.t(), [GitOps.Commit.t()], String.t(), String.t(), Keyword.t()) ::
  {String.t(), String.t()}

The updated changelog contents and the new entry, without touching the filesystem.

write(path, commits, last_version, current_version, opts \\ [])

@spec write(String.t(), [GitOps.Commit.t()], String.t(), String.t(), Keyword.t()) ::
  String.t()