deploygate

Upload a new build to DeployGate

You can retrieve your username and API token on your settings page.
More information about the available options can be found in the DeployGate Push API document.

deploygate
Supported platforms ios, android
Author @tnj, @tomorrowkey

2 Examples

deploygate(
  api_token: "...",
  user: "target username or organization name",
  ipa: "./ipa_file.ipa",
  message: "Build #{lane_context[SharedValues::BUILD_NUMBER]}",
  distribution_key: "(Optional) Target Distribution Key",
  distribution_name: "(Optional) Target Distribution Name"
)
deploygate(
  api_token: "...",
  user: "target username or organization name",
  apk: "./apk_file.apk",
  message: "Build #{lane_context[SharedValues::BUILD_NUMBER]}",
  distribution_key: "(Optional) Target Distribution Key",
  distribution_name: "(Optional) Target Distribution Name"
)

Parameters

Key Description Default
api_token Deploygate API Token
user Target username or organization name
ipa Path to your IPA file. Optional if you use the gym or xcodebuild action *
apk Path to your APK file *
message Release Notes No changelog provided
distribution_key Target Distribution Key
release_note Release note for distribution page
disable_notify Disables Push notification emails false
distribution_name Target Distribution Name

* = 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 deploygate action generates the following Lane Variables:

SharedValue Description
SharedValues::DEPLOYGATE_URL URL of the newly uploaded build
SharedValues::DEPLOYGATE_REVISION auto incremented revision number
SharedValues::DEPLOYGATE_APP_INFO Contains app revision, bundle identifier, etc.

To get more information check the Lanes documentation.


Documentation

To show the documentation in your terminal, run

fastlane action deploygate

CLI

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 deploygate

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

fastlane run deploygate 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