Plugin: generator-changelog-md
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.
Installation
Section titled “Installation”go install github.com/SemRels/generator-changelog-md@latestEach 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.
Configuration
Section titled “Configuration”version: 1plugins: - name: generator-changelog-md path: generator-changelog-md args: template: templates/changelog.md.tmpl max_commits: 100Environment Variables
Section titled “Environment Variables”| Name | Required | Default | Description |
|---|---|---|---|
SEMREL_PLUGIN_TEMPLATE | no | built-in template | Path to a Go template used to render the changelog. |
SEMREL_PLUGIN_MAX_COMMITS | no | 100 | Maximum number of commits to include. |
Release Context Variables
Section titled “Release Context Variables”SEMREL_TAG_NAMESEMREL_NEXT_VERSIONSEMREL_CURRENT_VERSIONSEMREL_BUMPSEMREL_BRANCHSEMREL_TAG_PREFIXSEMREL_DRY_RUN
Example Output
Section titled “Example Output”A generated changelog can look like:
## v1.4.0- feat: add search endpoint- fix: handle empty state