2019-08-25 23:51:43 -04:00
# https://help.github.com/en/articles/metadata-syntax-for-github-actions
2021-05-03 02:43:58 +02:00
name : "GH Release"
description : "Github Action for creating Github Releases"
author : "softprops"
2019-08-25 23:51:43 -04:00
inputs :
body :
2021-05-03 02:43:58 +02:00
description : "Note-worthy description of changes in release"
2019-08-25 23:51:43 -04:00
required : false
2019-09-29 08:45:47 -04:00
body_path :
2021-05-03 02:43:58 +02:00
description : "Path to load note-worthy description of changes in release from"
2019-08-26 01:26:13 -04:00
required : false
2019-08-25 23:51:43 -04:00
name :
2021-05-03 02:43:58 +02:00
description : "Gives the release a custom name. Defaults to tag name"
2019-08-25 23:51:43 -04:00
required : false
2020-01-09 15:06:19 +09:00
tag_name :
2025-04-10 22:58:19 +08:00
description : "Gives a tag name. Defaults to github.ref_name"
2020-01-09 15:06:19 +09:00
required : false
2019-08-25 23:51:43 -04:00
draft :
2021-05-03 02:43:58 +02:00
description : "Creates a draft release. Defaults to false"
2019-09-17 23:30:36 +09:00
required : false
prerelease :
2021-05-03 02:43:58 +02:00
description : "Identify the release as a prerelease. Defaults to false"
2019-08-25 23:51:43 -04:00
required : false
2024-11-11 21:14:02 +01:00
preserve_order :
description : "Preserver the order of the artifacts when uploading"
required : false
2019-08-25 23:51:43 -04:00
files :
2021-05-03 02:43:58 +02:00
description : "Newline-delimited list of path globs for asset files to upload"
2019-08-25 23:51:43 -04:00
required : false
2020-06-24 23:11:41 -07:00
fail_on_unmatched_files :
2021-05-03 02:43:58 +02:00
description : "Fails if any of the `files` globs match nothing. Defaults to false"
2020-06-24 23:11:41 -07:00
required : false
2020-12-20 14:44:30 -05:00
repository :
2021-05-03 02:43:58 +02:00
description : "Repository to make releases against, in <owner>/<repo> format"
2020-12-20 14:44:30 -05:00
required : false
2021-03-16 07:50:02 +03:00
token :
2021-05-03 02:43:58 +02:00
description : "Authorized secret GitHub Personal Access Token. Defaults to github.token"
2021-03-16 07:50:02 +03:00
required : false
default : ${{ github.token }}
2021-05-03 02:43:58 +02: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 02:07:02 -04: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 17:06:35 -05: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-23 00:40:31 +08:00
append_body :
2022-07-10 07:32:25 +03:00
description : "Append to existing body instead of overwriting it. Default is false."
2022-01-23 00:40:31 +08:00
required : false
2024-03-11 09:42:25 -04:00
make_latest :
description : "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Can be `true`, `false`, or `legacy`. Uses GitHub api default if not provided"
required : false
2019-09-09 18:26:06 +09:00
env :
2024-07-17 20:14:48 +02:00
GITHUB_TOKEN : "As provided by Github Actions"
2019-10-17 11:08:28 -04:00
outputs :
url :
2021-08-08 02:07:02 -04:00
description : "URL to the Release HTML Page"
2021-05-02 00:56:49 +02:00
id :
2021-08-08 02:07:02 -04:00
description : "Release ID"
2021-03-21 06:59:32 +01:00
upload_url :
2021-05-03 02:43:58 +02:00
description : "URL for uploading assets to the release"
2021-11-26 00:02:50 +01: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-25 23:51:43 -04:00
runs :
2024-02-05 12:48:15 -08:00
using : "node20"
2021-05-03 02:43:58 +02:00
main : "dist/index.js"
2019-08-25 23:51:43 -04:00
branding :
2021-05-03 02:43:58 +02:00
color : "green"
icon : "package"