How it works

The release deployment works with Octopod:Insight API. All are packaged into Octopod:Deployer tool to simplify integration. Octopod:Deployer is available for Windows and Linux.

• Windows

• Linux

Steps

1. Generate a manifest.json with options given ;

2. Create an archive with files present in source path given ;

3. Compile (if necessary) template score ;

4. Send manifest, archive, changelog and template score ;

5. Declare new release.

Arguments

./deployer --help

Octopod:Deployer.

Usage:
  deployer [--auth-token=<auth-token>] [--game=<game>] [--release-version=<release-version>] [--channel=<channel>] [--manifest=<manifest>] [--release-source=<release-source>] [--release-template=<release-template>]   [--release-changelog=<release-changelog>]
  deployer dry-run [--auth-token=<auth-token>] [--game=<game>] [--release-version=<release-version>] [--channel=<channel>]   [--manifest=<manifest>]
  deployer -h | --help
  deployer --version

Options:
  --auth-token=<auth-token>                Insight authentication token
  --game=<game>                            Game ID
  --channel=<channel>                      Channel used to release
  --manifest=<manifest>                    Manifest location
  --release-changelog=<release-changelog>  Release changelog location - Contains release description
  --release-source=<release-source>        Release source location
  --release-template=<release-template>    Release "template score" location
  --release-version=<release-version>      Release version
  -h --help                                Show this screen.
  --version                                Show version.

• --auth-token is the Octopod:Insight token to deploy with your account.

• --game represents the game id. It’s a unique key given by Octopod:Insight.

• --channel is the channel targeted. Currently, stable and alpha are supported.

• --manifest is the path to your release manifest.

• --release-changelog is the path to your release changelog (optional).

• --release-source is the path to release source.

• --release-template is the path to template score (optional).

• --release-version is the version of the release to deploy.

• --help display command explications about arguments and options.

• --version display Octopod:Deployer version.

Note

Token to use with --auth-token can be created on your account, https://studio.octopodvr.com.

Note

--release-version represents the version of your release. This value will be set in the version field into the manifest. So you can ignore the field version into manifest, this field will be set.

Note

Currently, no method upgrade is available into Octopod:Deployer to check last version and download the latest. So, we recommend you to download last binary before each deployment.