Zum Inhalt springen

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.

Terminal-Fenster
semrel plugin install @semrel/generator-changelog-html
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_CHANGELOG
NameRequiredDefaultDescription
SEMREL_PLUGIN_TEMPLATEnobuilt-inPath to a custom Go HTML template.
SEMREL_PLUGIN_CSS_FILEno—Optional CSS file to embed or reference in the HTML output.
SEMREL_PLUGIN_MAX_COMMITSno100Maximum commits to include.
SEMREL_PLUGIN_SIGNATUREnofalseAppend an opt-in footer element linking to https://semrel.io at the end of the generated HTML entry.
SEMREL_PLUGIN_AI_DISCLOSUREnofalseDetect AI co-author trailers and append a badge to each AI-assisted commit entry.
SEMREL_PLUGIN_AI_DISCLOSURE_BADGEno🤖Badge appended to AI-assisted entries.
SEMREL_PLUGIN_AI_DISCLOSURE_SECTIONnofalseAppend a collapsible <details> block listing all AI-co-authored commits (requires SEMREL_PLUGIN_AI_DISCLOSURE=true).
SEMREL_PLUGIN_SECTIONS_JSONnobuilt-inJSON array overriding the commit-type → section mapping (e.g. [{"type":"feat","section":"Features"},{"type":"docs","hidden":true}]).
SEMREL_PLUGIN_FIRST_TIME_CONTRIBUTORSnotrueAppend a New Contributors section when SEMREL_CONTRIBUTORS data is available (alias: SEMREL_PLUGIN_NEW_CONTRIBUTORS).
SEMREL_PLUGIN_RELEASE_MVPnofalseAppend a 🏆 Release MVP section highlighting the top contributor (alias: SEMREL_PLUGIN_MVP).
SEMREL_PLUGIN_MVP_METRICnocommitsMetric used for MVP selection (commits or impact).

When SEMREL_PLUGIN_SIGNATURE=true, the generated HTML ends with:

<footer><small>Generated by <a href="https://semrel.io">semrel.io</a></small></footer>