Module changelog 

Composing the changelog out of what the repository already states.

Nothing here is authored. A section per release record, newest first, with an unreleased section leading when there is work after the last one:

  release record  ──►  version, tag, date, commit, artifacts
  adr objects     ──►  the decisions dated inside this release's window
  git log A..B    ──►  the changes, as conventional commits

The window of a release is (previous release's date, this release's date] for the decisions and previous..this for the commits. Both are the same interval said in the two vocabularies the two sources have — an ADR carries a date and no commit, and a commit carries no date the layer indexes.

Constants

ADR_KIND

The kind the layer gives a decision.

RELEASE_KIND

The kind the layer gives a published release.

Functions

compose

Compose the changelog, unreleased section included.

compose_published

Compose the changelog of what has been published, and nothing after it.

render

The changelog as Markdown, which is what the generated document and the site render.