Skip to main content

compose_published

Function compose_published 

Source
pub fn compose_published(root: &Path, objects: &[Object]) -> Changelog
Expand description

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

The one form a committed artifact may take. The unreleased section is <last release>..HEAD, and a file inside a commit cannot describe the commit it is in: every commit made the committed changelog stale by construction, the pre-commit gate refused until a full derive had run, and every session paid several minutes per commit or worked around the gate. A document that depends only on the release records and the history up to the newest of them is the same bytes at every commit that changes neither, which is what “current” has to mean for a file under docs/generated/.

A repository with no records yields no section at all here — there is nothing published to describe — where compose yields the unreleased one.