appetize
Upload your app to Appetize.io to stream it in browser
If you provide a
public_key
, this will overwrite an existing application. If you want to have this build as a new app version, you shouldn't provide this value.
To integrate appetize into your GitHub workflow check out the device_grid guide.
appetize | |
---|---|
Supported platforms | ios, android |
Author | @klundberg, @giginet, @steprescott |
2 Examples
appetize(
path: "./MyApp.zip",
api_token: "yourapitoken", # get it from https://appetize.io/docs#request-api-token
public_key: "your_public_key" # get it from https://appetize.io/dashboard
)
appetize(
path: "./MyApp.zip",
api_host: "company.appetize.io", # only needed for enterprise hosted solution
api_token: "yourapitoken", # get it from https://appetize.io/docs#request-api-token
public_key: "your_public_key" # get it from https://appetize.io/dashboard
)
Parameters
Key | Description | Default |
---|---|---|
api_host |
Appetize API host | api.appetize.io |
api_token |
Appetize.io API Token | |
url |
URL from which the ipa file can be fetched. Alternative to :path | |
platform |
Platform. Either ios or android |
ios |
path |
Path to zipped build on the local filesystem. Either this or url must be specified |
|
public_key |
If not provided, a new app will be created. If provided, the existing build will be overwritten | |
note |
Notes you wish to add to the uploaded app | |
timeout |
The number of seconds to wait until automatically ending the session due to user inactivity. Must be 30, 60, 90, 120, 180, 300, 600, 1800, 3600 or 7200. Default is 120 |
* = 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 appetize
action generates the following Lane Variables:
SharedValue | Description |
---|---|
SharedValues::APPETIZE_API_HOST |
Appetize API host. |
SharedValues::APPETIZE_PUBLIC_KEY |
a public identifier for your app. Use this to update your app after it has been initially created. |
SharedValues::APPETIZE_APP_URL |
a page to test and share your app. |
SharedValues::APPETIZE_MANAGE_URL |
a page to manage your app. |
To get more information check the Lanes documentation.
Documentation
To show the documentation in your terminal, run
fastlane action appetize
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 appetize
To pass parameters, make use of the :
symbol, for example
fastlane run appetize 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