purpleclay/Release Note
Generate a release note for your project
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| working-directory | Directory containing the git repository to generate a release note for | no | ${{ github.workspace }} |
| version | Version of release-note to download. Defaults to the version this action release was tested against. | no | "" |
| token | GitHub token for API requests (release download, contributor attribution and avatars) | no | ${{ github.token }} |
| output | Path the generated release note is written to. Defaults to a file under the runner's temp directory — outside the workspace, so the working tree stays clean (GoReleaser --clean, git status gates) and no later step can accidentally commit it. | no | "" |
Outputs
| name | description |
|---|---|
| release-note-path | Path to the generated release note |
| release-note-version | The release-note version that was executed |