livery.extensions.changelog._cliff¶
livery.extensions.changelog._cliff ¶
The changelog extension's engine: git-cliff, driven per package.
Each package carries a cliff.toml, the extension's per-package
content, which states its tag line, its paths, and the entry's shape.
This module runs git-cliff against that config for the entry the
commits since the last release earn, and NOTES, the extension's
answer to the workshop's release-notes query, writes it into the
package's CHANGELOG.md. The next version is not git-cliff's: the
workshop derives it from the same commits.
Classes:
| Name | Description |
|---|---|
CliffChangelog |
Release notes as git-cliff entries in each package's |
Functions:
| Name | Description |
|---|---|
credit_is_reachable |
Whether a credential is in reach to ask the forge who wrote what. |
config_path |
package's changelog contract, or fail naming what to render. |
unreleased_entry |
The changelog entry for what is unreleased in package. |
notes |
Answer the |
Attributes:
| Name | Type | Description |
|---|---|---|
CONFIG_NAME |
|
|
TOKEN_VARIABLE |
|
|
NOTES |
|
TOKEN_VARIABLE
module-attribute
¶
CliffChangelog ¶
Release notes as git-cliff entries in each package's CHANGELOG.md.
The extension's livery.workshop.ReleaseNotes provider: the entry
is git-cliff's, through the package's cliff.toml; the history is
the package's CHANGELOG.md, created at the first record, newest
entry first.
Methods:
| Name | Description |
|---|---|
entry |
The entry git-cliff writes for what is unreleased in package. |
record |
Write version's entry at the top of |
verify |
A missing |
entry ¶
The entry git-cliff writes for what is unreleased in package.
record ¶
Write version's entry at the top of CHANGELOG.md.
An entry already under version's heading is replaced when a new one is given: the stranded shape, a heading whose tag never cut, regenerates rather than under-documenting what ships.
Source code in packages/extensions/changelog/src/livery/extensions/changelog/_cliff.py
verify ¶
A missing ## <version> entry in CHANGELOG.md, or nothing.
Source code in packages/extensions/changelog/src/livery/extensions/changelog/_cliff.py
credit_is_reachable ¶
Whether a credential is in reach to ask the forge who wrote what.
The changelog names authors by asking the forge, which a private repository answers only for a caller it can authenticate. Without the credential git-cliff stops rather than degrading, so the caller runs it offline instead.
Source code in packages/extensions/changelog/src/livery/extensions/changelog/_cliff.py
config_path ¶
package's changelog contract, or fail naming what to render.
Source code in packages/extensions/changelog/src/livery/extensions/changelog/_cliff.py
unreleased_entry ¶
The changelog entry for what is unreleased in package.
With version, the entry is headed by it and dated today, and
credits its authors where a credential is in reach. Without one it
is headed ## [Unreleased], which is what a dev build's excerpt
wants, and credits no one: nobody credits a dev build's authors,
and the lookup pages through every pull request the forge holds,
once per package, against the forge's API budget. Empty when no
commit touches the package.
Source code in packages/extensions/changelog/src/livery/extensions/changelog/_cliff.py
notes ¶
notes(root: Path) -> ReleaseNotes
Answer the release-notes query about the workspace at root with NOTES.