splitter

splitter

A command to deploy your apps to several mobile app distribution services. The motivation of splitter is to encourage Mobile App Deployment as Code.

// for internal dogfooding
splitter deploy -f path/to/aab -n dogfooding

// for pull request
splitter deploy -f path/to/aab -n pull-request

// for design reviews
splitter deploy -f path/to/aab -n design-review

Install

Please download the latest binary from GitHub Release. The following code may be useful.

version=<latest version>

# for windows
curl -sL -o "splitter.zip" \
    "https://github.com/jmatsu/splitter/releases/download/$version/splitter_$(uname -s)_$(uname -m).zip"
unzip splitter.zip
./spliter -h

# for linux or macOS
curl -sL -o "splitter.tar" \
    "https://github.com/jmatsu/splitter/releases/download/$version/splitter_$(uname -s)_$(uname -m).tar.gz"
tar -xf splitter.tar
./spliter -h

Configuration-based deployment

splitter allows you to manage deployment configuration as Code. This feature makes you focus on defining deployments.

USAGE:
   splitter deploy [command options] [arguments...]

OPTIONS:
   --name value, -n value         deployment name in your configuration file. [$SPLITTER_DEPLOYMENT_NAME]
   --source-path value, -f value  A path to an app file.
   --release-note value           An release note of this revision. Some of services may not support this option. [$SPLITTER_DEPLOYMENT_RELEASE_NOTE]

Syntax

Please check splitter.document.yml and examples/splitter.yml as well.

DeployGate configuration

Required

• app-owner-name
• api-token

https://github.com/jmatsu/splitter/blob/main/internal/config/deploygate_config.go

Firebase App Distribution configuration

Required

• app-id
• access-token or credentials-path

https://github.com/jmatsu/splitter/blob/main/internal/config/firebase_app_distribution_config.go

Local configuration

Required

• destination-path

https://github.com/jmatsu/splitter/blob/main/internal/config/local_config.go

Custom service configuration

Required

• auth-token

https://github.com/jmatsu/splitter/blob/main/internal/config/custom_service_config.go

Pre-/Post-Steps

You can define pre-steps that will be executed before the deployment and post-steps that will be executed after the successful deployment.

Limitation

• Non-zero status will halt the following steps and deployment.
• Every step will be executed on different shells so variables are not inherited to other steps.

On-demand deployment

splitter provides commands specified for deployment to each service. This mode doesn't use deployments configuration in the config file.

These commands may accept finer-grained options than the configuration-based command.

DeployGate - https://deploygate.com/

The minimum behaviour just creates new releases, but you can create and/or Distribution.

USAGE:
   splitter deploygate [command options] [arguments...]

OPTIONS:
   --app-owner-name value, -n value   User name or Organization name. [$DEPLOYGATE_APP_OWNER_NAME]
   --api-token value, -t value        The api token of the app owner. [$DEPLOYGATE_API_TOKEN]
   --source-path value, -f value      A path to an app file.
   --message value, -m value          A short message of this revision.
   --distribution-access-key value    An access key of a distribution that must exist. If the both of key and name are specified, key takes priority.
   --distribution-name value          An name (title) of a distribution that does not have to exist. If the both of key and name are specified, key takes priority.
   --distribution-release-note value  An release note of this revision that will be available only while being distributed via the specified distribution.
   --disable-ios-notification         Specify this file if you would like to disable notifications for iOS. (default: false)

Firebase App Distribution - https://firebase.google.com/docs/app-distribution

The minimum behaviour just creates new releases, but you can update release notes and distribute to specific groups.

USAGE:
   splitter firebase-app-distribution [command options] [arguments...]

OPTIONS:
   --app-id value                  Firebase App ID. e.g. 1:123456578:android:xxxxxxx [$FIREBASE_APP_ID]
   --source-path value, -f value   A path to an app file.
   --access-token value, -t value  The access token to use for this distribution. [$FIREBASE_CLI_TOKEN]
   --credentials value             A path to a credentials json file.
   --release-note value            An release note of this revision.
   --group-aliases value           Aliases of groups. Separate multiple aliases by commas.
   --tester-emails value           Emails of testers. Separate multiple aliases by commas.

To get your access token, we recommend https://github.com/google/oauth2l.

Local

Your local file system.

USAGE:
   splitter local [command options] [arguments...]

OPTIONS:
   --source-path value, -f value       A source path to an app file.
   --destination-path value            A destination path to an app file.
   --delete-source                     Specify true if you would not like to keep the source file. (default: false)
   --overwrite                         Specify true if you allow to overwrite the existing destination file. (default: false)
   --file-mode value                   The final file permission of the destination path. (default: Same to the source)

Custom Service

service command does this. You can distribute your apps to the defined service in the config file.

USAGE:
   splitter service [command options] [arguments...]

OPTIONS:
   --source-path value, -f value                A path to an app file.
   --auth-token value, -t value                 The auth token to use for this distribution.
   --name value, -n value                       A service name in the config file.
   --header value [ --header value ]            Append <key>=<value> to headers
   --query-param value [ --query-param value ]  Append <key>=<value> to query parameters
   --form-param value [ --form-param value ]    Append <key>=<value> to form parameters

About the supported services

• DeployGate - https://deploygate.com/
• Firebase App Distribution - https://firebase.google.com/docs/app-distribution
• Local - Your local file system.

LICENSE

splitter is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.