cabauman/Changelogger
Outputs a changelog diff since the last full release. I'm a fan of standard-version, but at the time of writing it doesn't support including prerelease commits when a full release is made. This addresses that limitation.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| preamble | Message positioned before the list of commits. Prefixed with '## ' (header markdown). | no | What's changed? |
| is-conventional | If false, it just returns a simple list of commits messages. If true, it parses conventional commits and organizes them into sections (like any conventional changelog library). By default, only feat, fix, and breaking changes are included. Will use the .versionrc file if present in the root directory. | no | true |
| output-flavor | Options: github-release, markdown, slack github-release: GitHub Releases support autolinked references + formatting. Source: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls markdown: Basic GitHub markdown without autolinked references. This option isn't ready yet so it currenlty uses github-release as a fallback. slack: Slack uses its own special markup language called mrkdwn. Source: https://api.slack.com/reference/surfaces/formatting | no | github-release |
| branch-comparison-strategy | Options: tag, workflow Only applies when the workflow trigger ref starts with `refs/heads/` tag: searches for the last non-prerelease tag, and uses that to compare against HEAD workflow: searches for the last successful workflow run for the current branch + current workflow, and uses that to compare against HEAD | no | tag |
| aggregate-prereleases | Whether or not to combine all prerelease commits since the last full release. | no | true |
| token | Used to access releases and workflows. | no | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| changelog | The generated changelog for the new version. |