defra/Generate Release Notes
Generate release notes from a template and git commit history using Nunjucks
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Apr 28, 2025
- License
- None
Pinned Snippet
uses: defra/release-notes-action@5daed6359429ebddc7cf3e64a107272d8b7ecb5d # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| template-file | Path to the Nunjucks template file | yes | — |
| output-file | Path to output the generated release notes | yes | — |
| release-version | Release version number | yes | — |
| template-data | Additional JSON object containing data to be passed to the template | no | {} |
| base-branch | Base branch to compare against (e.g., master or main) | no | master |
| release-branch | Release branch containing the changes | yes | — |
| ticket-pattern | Regex pattern to extract ticket IDs from commit messages. Use a wider pattern like `[A-Z]+-[0-9]+.*` to include the commit message text. | no | [A-Z]+-[0-9]+ |
| git-user-name | Git user name for the commit | no | GitHub Action |
| git-user-email | Git user email for the commit | no | action@github.com |
Outputs
no outputs