Plugin: generator-release-notes
Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.
Builds concise release notes from the current release context and commit history. It is a good fit for provider plugins that publish release descriptions to Git forges.
Installation
Section titled “Installation”go install github.com/SemRels/generator-release-notes@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-release-notes path: generator-release-notes args: template: templates/release-notes.tmpl max_commits: 50 include_body: falseEnvironment Variables
Section titled “Environment Variables”| Name | Required | Default | Description |
|---|---|---|---|
SEMREL_PLUGIN_TEMPLATE | no | built-in template | Path to a Go template used to render release notes. |
SEMREL_PLUGIN_MAX_COMMITS | no | 50 | Maximum number of commits to include. |
SEMREL_PLUGIN_INCLUDE_BODY | no | false | Include the full commit body in the generated notes. |
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 release note can summarize v1.4.0, highlight the bump level, and list the top 50 commits selected for the release.