Tags plus reads become a Changelog value. Pure.
Every effect arrives as an injected function, so the whole assembly runs against maps in a test and against git in a release.
Tags plus reads become a Changelog value. Pure. Every effect arrives as an injected function, so the whole assembly runs against maps in a test and against git in a release.
(assemble ranges' {:keys [messages-fn date-fn prose-fn]})Ranges into Releases, reading through the injected fns.
messages-fn [from to] -> commit messages, date-fn [tag] -> date string
or nil, prose-fn [version] -> authored markdown or nil.
Ranges into Releases, reading through the injected fns. `messages-fn` [from to] -> commit messages, `date-fn` [tag] -> date string or nil, `prose-fn` [version] -> authored markdown or nil.
How many releases the generated file carries in full.
A library with four hundred tags would otherwise render four hundred sections, and the reader deciding whether to bump is looking at the top.
How many releases the generated file carries in full. A library with four hundred tags would otherwise render four hundred sections, and the reader deciding whether to bump is looking at the top.
(document tags
{:keys [depth preamble pending] :or {depth default-depth} :as reads})The Changelog value for tags (newest first, complete).
:pending names the release being cut but not yet tagged, and adds it at
the top with HEAD as its endpoint. Without it a changelog generated during
a release describes every version EXCEPT the one being released, which is
the staleness this file exists to avoid.
:depth bounds how many releases are rendered in full; the rest are named
in the footer rather than dropped silently.
The Changelog value for `tags` (newest first, complete). `:pending` names the release being cut but not yet tagged, and adds it at the top with HEAD as its endpoint. Without it a changelog generated during a release describes every version EXCEPT the one being released, which is the staleness this file exists to avoid. `:depth` bounds how many releases are rendered in full; the rest are named in the footer rather than dropped silently.
(ranges tags)Adjacent tag pairs, newest first.
tags must be newest first and COMPLETE: the oldest one's range opens at
the root of history, and truncating the input before this would attribute
the whole history to whatever release happened to be last.
Adjacent tag pairs, newest first. `tags` must be newest first and COMPLETE: the oldest one's range opens at the root of history, and truncating the input before this would attribute the whole history to whatever release happened to be last.
(version-of tag)The version a v-prefixed tag names.
The version a v-prefixed tag names.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |