kipngetich98/Smart Release Notes Generator
Automatically generate comprehensive release notes from your GitHub repository
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| token | GitHub token for API access | yes | ${{ github.token }} |
| repository | The repository in the format owner/repo | no | ${{ github.repository }} |
| tag | The tag to generate release notes for. If not provided, will use the latest tag | no | ${{ github.ref }} |
| previous-tag | The previous tag to compare against. If not provided, will use the tag before the current one | no | — |
| config-file | Path to a custom configuration file | no | .github/release-notes-config.yml |
| include-commits | Whether to include commits in the release notes | no | true |
| include-pull-requests | Whether to include pull requests in the release notes | no | true |
| include-contributors | Whether to include contributors in the release notes | no | true |
| categorize | Whether to categorize changes based on labels or commit messages | no | true |
| template | Custom template for the release notes in Handlebars format | no | — |
| output-file | File to write the release notes to. If not provided, will output to the GitHub step summary | no | — |
Outputs
| name | description |
|---|---|
| release-notes | The generated release notes in markdown format |
| contributors | JSON array of contributors to the release |
| summary | A summary of the changes in the release |