Plugin: generator-changelog-html
Generates an HTML changelog from the release context and commit history. Running as a generator phase plugin, its stdout overrides the default SEMREL_CHANGELOG value that provider and hook plugins receive — useful for platforms that accept HTML release descriptions.
Installation
Abschnitt betitelt „Installation“semrel plugin install @semrel/generator-changelog-htmlConfiguration
Abschnitt betitelt „Configuration“plugins: - uses: @semrel/generator-changelog-html phase: generator # stdout captured by semrel → becomes SEMREL_CHANGELOG args: template: .semrel/templates/changelog.html.tmpl # optional css_file: .semrel/templates/changelog.css # optional signature: "true" # optional semrel.io footer, opt-in max_commits: "100" - uses: @semrel/provider-github # receives the HTML as SEMREL_CHANGELOGEnvironment variables
Abschnitt betitelt „Environment variables“| Name | Required | Default | Description |
|---|---|---|---|
SEMREL_PLUGIN_TEMPLATE | no | built-in | Path to a custom Go HTML template. |
SEMREL_PLUGIN_CSS_FILE | no | — | Optional CSS file to embed or reference in the HTML output. |
SEMREL_PLUGIN_MAX_COMMITS | no | 100 | Maximum commits to include. |
SEMREL_PLUGIN_SIGNATURE | no | false | Append an opt-in footer element linking to https://semrel.io at the end of the generated HTML entry. |
SEMREL_PLUGIN_AI_DISCLOSURE | no | false | Detect AI co-author trailers and append a badge to each AI-assisted commit entry. |
SEMREL_PLUGIN_AI_DISCLOSURE_BADGE | no | 🤖 | Badge appended to AI-assisted entries. |
SEMREL_PLUGIN_AI_DISCLOSURE_SECTION | no | false | Append a collapsible <details> block listing all AI-co-authored commits (requires SEMREL_PLUGIN_AI_DISCLOSURE=true). |
When SEMREL_PLUGIN_SIGNATURE=true, the generated HTML ends with:
<footer><small>Generated by <a href="https://semrel.io">semrel.io</a></small></footer>