Generate release notes content for a release
contents: write
permission is requireddiscussions: write
permission is required ifdiscussion-category
is used
permissions:
contents: write
discussions: write
Input | Required? | Default | Description |
---|---|---|---|
tag |
yes | ${{ github.ref_name }} |
Tag name for the release. This can be an existing tag or a new one. |
name |
no | Name for the release. Auto-generated if generate-release-notes is set |
|
body |
no | Body content for the release. Auto-generated if generate-release-notes is set |
|
body-file |
no | File path of the body content to be included in the release | |
generate-release-notes |
yes | true |
Automatically generate release notes. Set to true to generate release notes from the latest release. Valid values: true , false or tag |
prerelease |
no | false |
Mark release as a prerelease. Valid values: true or false |
files |
no | Files to attach to the release. One file per line | |
discussion-category |
no | Github Discussion category to create a discussion for the Release | |
dry-run |
no | false |
Run without creating the Release. Valid values: true or false |
token |
yes | ${{ github.token }} |
Github token to use |
Output | Description |
---|---|
id |
Release ID. Empty string on dry-run |
url |
Release URL. Empty string on dry-run |
name |
Name for the release |
body |
Body content for the release |
tag |
Tag name for the release |
prerelease |
Release is a prerelease |
json |
Raw data of the release in JSON |