Zum Inhalt springen

Plugin: generator-changelog-md

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

Generates a Markdown changelog for the pending release. Use it when you want changelog output that can be committed, published, or reused by provider plugins.

Terminal window
go install github.com/SemRels/generator-changelog-md@latest

Each plugin is a standalone Go binary. Keep it on your PATH or reference it with path: in .semrel.yaml. If you keep secrets in a .env file, load them with semrel --env-file .env release.

version: 1
plugins:
- name: generator-changelog-md
path: generator-changelog-md
args:
template: templates/changelog.md.tmpl
max_commits: 100
NameRequiredDefaultDescription
SEMREL_PLUGIN_TEMPLATEnobuilt-in templatePath to a Go template used to render the changelog.
SEMREL_PLUGIN_MAX_COMMITSno100Maximum number of commits to include.
  • SEMREL_TAG_NAME
  • SEMREL_NEXT_VERSION
  • SEMREL_CURRENT_VERSION
  • SEMREL_BUMP
  • SEMREL_BRANCH
  • SEMREL_TAG_PREFIX
  • SEMREL_DRY_RUN

A generated changelog can look like:

## v1.4.0
- feat: add search endpoint
- fix: handle empty state