This will verify if a given release version is available on GitHub

This will return all information about a release. For example:

   "name"=>"1.8.0 Switch Lanes & Pass Parameters",
   "body"=> ...Markdown...
  "This is one of the biggest updates of _fastlane_ yet"
Supported platforms ios, android, mac
Author @KrauseFx, @czechboy0, @jaleksynas, @tommeier

1 Example

release = get_github_release(url: "fastlane/fastlane", version: "1.0.0")
puts release["name"]


Key Description Default
url The path to your repo, e.g. 'KrauseFx/fastlane'
server_url The server url. e.g. 'https://your.github.server/api/v3' (Default: '')
version The version tag of the release to check
api_token GitHub Personal Token (required for private repositories) *
api_bearer Use a Bearer authorization token. Usually generated by GitHub Apps, e.g. GitHub Actions GITHUB_TOKEN environment variable

* = default value is dependent on the user's system

Lane Variables

Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The get_github_release action generates the following Lane Variables:

SharedValue Description
SharedValues::GET_GITHUB_RELEASE_INFO Contains all the information about this release

To get more information check the Lanes documentation.


To show the documentation in your terminal, run

fastlane action get_github_release


It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run get_github_release

To pass parameters, make use of the : symbol, for example

fastlane run get_github_release parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.

Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub

Back to actions