-
-
Notifications
You must be signed in to change notification settings - Fork 0
Release Notes
David Ortner edited this page Jan 31, 2024
·
6 revisions
Outputs release notes based on commits and tags (versions) in the repository.
By default it will output release notes for commits between the two latest tags (versions).
Basic Usage
happy-release-notesPipe to file
happy-release-notes > release-notes.mdBetween two versions
happy-release-notes --author=githubUsername --authorUsername=fallbackUsername --from=v0.0.1 --to=v0.0.3| Argument | Description | Default |
|---|---|---|
| --from={version} | The version to generate release notes from. | Second latest version. |
| --to={version} | The version to generate release notes to. | Latest version. |
| --versionHeader | Show version header. Useful when generating release notes for multiple releases. | |
| --author={githubUsername | nameAndEmail} | Show author for each entry. Tries to find Github username based on email if set to "githubUsername". | |
| --authorUsername={username} | Username as author when "--author" is not specified or if it was not possible to retrieve the Github username based on email. |