kevinrohn/Github release data

Get all data from Github release of a given repository.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit Apr 15, 2025
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: kevinrohn/github-full-release-data@b874db36b8a5212b438c4118f611dd76b356c20f # v2.0.7

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
repository(Optional) Repository name to fetch release data. If no repository is passed as an input. The repository from the build workflow is used. It's possible to fetch release data from any given repository. Just use `<org>/<repo>` as an input parameter. It's also possible to fetch release data from private repositories. In this case just pass the `token` input parameter. no${{ github.repository }}
token(Optional) `token` of the private repository from which the release information should be retrieved. Pass the input parameter `token` to fetch release information from private repositories. e.g.: `secrets.GITHUB_TOKEN` no${{ github.token }}
version(Optional) The version from which the release information is to be retrieved. If the input value is not set, the default value `latest` is used. It's possible to fetch release data from a given tag. To fetch a specific tag just use `<tag-name>`. nolatest
body-markdown-file-path(Optional) Specify an output path where the body output should be saved. If the path is valid and the file is accessible then, the body output content will be saved into the file. Save the file in the current working directory: ./release-content.md no
asset-file(Optional) Name of the asset files to download. To download release asset files, just use the input parameter `asset-file`. To download multiple release asset files use `,` comma as a separator. Example: Download all .PNG and .JPEG files: `*.PNG,*.JPEG` Download release asset with a static name: `myfile-to-download.extension` no
asset-output(Optional) The output path in which the downloaded asset files should be placed. If no input is set, the workspace path is used. no./
namedescription
urlRelease url to use in api calls
html_urlRelease url
assets_urlAsset url to use in api calls
upload_urlUpload url for release assets
tarball_urlUrl to tarball content
zipball_urlUrl to zipball content
discussion_urlDiscussion url - can be `null` if discussion is deactivated
idRelease id
node_idRelease node id
tag_nameRelease tag name
target_commitishTarget from which the release is created
nameRelease name
bodyThe `body` output from release. It's a multiline output, which is packed in a JSON object. The output can be used with the `fromJSON` function `(steps.<id>.outputs.body)`. This workaround is applied because of the following multiline output problem. [set-output truncates multiline strings](https://github.community/t/set-output-truncates-multiline-strings/16852/9)
draftShows if the release is a draft release or not (true/false)
prereleaseShows if the release is a pre-release (true/false)
created_atShows the release creation date
published_atShows the published date of the release
assets_array_jsonThe `assets_array_json` output from release. It's a multiline output, which is packed in a JSON object. The output can be used with the `fromJSON` function `(steps.<id>.outputs.assets_array_json)`.
author_jsonThe `author_json` output from release. It's a multiline output, which is packed in a JSON object. The output can be used with the `fromJSON` function `(steps.<id>.outputs.author_json)`.