2019-08-26 03:51:43 +00:00
# https://help.github.com/en/articles/metadata-syntax-for-github-actions
2021-05-03 00:43:58 +00:00
name : "GH Release"
description : "Github Action for creating Github Releases"
author : "softprops"
2019-08-26 03:51:43 +00:00
inputs :
body :
2021-05-03 00:43:58 +00:00
description : "Note-worthy description of changes in release"
2019-08-26 03:51:43 +00:00
required : false
2019-09-29 12:45:47 +00:00
body_path :
2021-05-03 00:43:58 +00:00
description : "Path to load note-worthy description of changes in release from"
2019-08-26 05:26:13 +00:00
required : false
2019-08-26 03:51:43 +00:00
name :
2021-05-03 00:43:58 +00:00
description : "Gives the release a custom name. Defaults to tag name"
2019-08-26 03:51:43 +00:00
required : false
2020-01-09 06:06:19 +00:00
tag_name :
2021-05-03 00:43:58 +00:00
description : "Gives a tag name. Defaults to github.GITHUB_REF"
2020-01-09 06:06:19 +00:00
required : false
2019-08-26 03:51:43 +00:00
draft :
2021-05-03 00:43:58 +00:00
description : "Creates a draft release. Defaults to false"
2019-09-17 14:30:36 +00:00
required : false
prerelease :
2021-05-03 00:43:58 +00:00
description : "Identify the release as a prerelease. Defaults to false"
2019-08-26 03:51:43 +00:00
required : false
files :
2021-05-03 00:43:58 +00:00
description : "Newline-delimited list of path globs for asset files to upload"
2019-08-26 03:51:43 +00:00
required : false
2020-06-25 06:11:41 +00:00
fail_on_unmatched_files :
2021-05-03 00:43:58 +00:00
description : "Fails if any of the `files` globs match nothing. Defaults to false"
2020-06-25 06:11:41 +00:00
required : false
2020-12-20 19:44:30 +00:00
repository :
2021-05-03 00:43:58 +00:00
description : "Repository to make releases against, in <owner>/<repo> format"
2020-12-20 19:44:30 +00:00
required : false
2021-03-16 04:50:02 +00:00
token :
2021-05-03 00:43:58 +00:00
description : "Authorized secret GitHub Personal Access Token. Defaults to github.token"
2021-03-16 04:50:02 +00:00
required : false
default : ${{ github.token }}
2021-05-03 00:43:58 +00:00
target_commitish :
description : "Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA."
required : false
2021-08-08 06:07:02 +00:00
discussion_category_name :
description : "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored."
required : false
2021-11-07 22:06:35 +00:00
generate_release_notes :
description : "Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes."
required : false
2022-01-22 16:40:31 +00:00
append_body :
2022-07-10 04:32:25 +00:00
description : "Append to existing body instead of overwriting it. Default is false."
2022-01-22 16:40:31 +00:00
required : false
2019-09-09 09:26:06 +00:00
env :
2021-05-03 00:43:58 +00:00
"GITHUB_TOKEN": "As provided by Github Actions"
2019-10-17 15:08:28 +00:00
outputs :
url :
2021-08-08 06:07:02 +00:00
description : "URL to the Release HTML Page"
2021-05-01 22:56:49 +00:00
id :
2021-08-08 06:07:02 +00:00
description : "Release ID"
2021-03-21 05:59:32 +00:00
upload_url :
2021-05-03 00:43:58 +00:00
description : "URL for uploading assets to the release"
2021-11-25 23:02:50 +00:00
assets :
description : "JSON array containing information about each uploaded asset, in the format given [here](https://docs.github.com/en/rest/reference/repos#upload-a-release-asset--code-samples) (minus the `uploader` field)"
2019-08-26 03:51:43 +00:00
runs :
2022-11-21 06:50:24 +00:00
using : "node16"
2021-05-03 00:43:58 +00:00
main : "dist/index.js"
2019-08-26 03:51:43 +00:00
branding :
2021-05-03 00:43:58 +00:00
color : "green"
icon : "package"
