This will create a new release on GitHub and upload assets for it
Creates a new release on GitHub. You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new), the repository name and tag name. By default, that's
If the tag doesn't exist, one will be created on the commit or branch passed in as commitish.
Out parameters provide the release's id, which can be used for later editing and the release HTML link to GitHub. You can also specify a list of assets to be uploaded to the release with the
|Supported platforms||ios, android, mac|
|Returns||A hash containing all relevant information of this release
Access things like 'html_url', 'tag_name', 'name', 'body'
github_release = set_github_release( repository_name: "fastlane/fastlane", api_token: ENV["GITHUB_TOKEN"], name: "Super New actions", tag_name: "v1.22.0", description: (File.read("changelog") rescue "No changelog provided"), commitish: "master", upload_assets: ["example_integration.ipa", "./pkg/built.gem"] )
||The path to your repo, e.g. 'fastlane/fastlane'|
||The server url. e.g. 'https://your.internal.github.host/api/v3' (Default: 'https://api.github.com')||
||Personal API Token for GitHub - generate one at https://github.com/settings/tokens||*|
||Use a Bearer authorization token. Usually generated by Github Apps, e.g. GitHub Actions GITHUB_TOKEN environment variable|
||Pass in the tag name|
||Name of this release|
||Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master)|
||Description of this release||*|
||Whether the release should be marked as draft||
||Whether the release should be marked as prerelease||
||Whether the name and body of this release should be generated automatically||
||Path to assets to be uploaded with the release|
* = default value is dependent on the user's system
Actions can communicate with each other using a shared hash
lane_context, that can be accessed in other actions, plugins or your lanes:
set_github_release action generates the following Lane Variables:
||Link to your created release|
||Release id (useful for subsequent editing)|
||The whole release JSON object|
To get more information check the Lanes documentation.
To show the documentation in your terminal, run
fastlane action set_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 set_github_release
To pass parameters, make use of the
: symbol, for example
fastlane run set_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
This action, just like the rest of fastlane, is fully open source, view the source code on GitHub