This page documents deployments using the next major version dpl v2, which currently is in a beta release phase. Please see our blog post for details. The current default version is dpl v1. Check dpl v1 documentation here.

Be sure to read the v2 deployment overview.

Travis CI can automatically deploy files to Gleis after a successful build.

For a minimal configuration, add the following to your .travis.yml:

  provider: gleis
  username: <username>
  password: <encrypted password>
  edge: true # opt in to dpl v2

Status #

Support for deployments to Gleis is in alpha. Please see Maturity Levels for details.

Known options #

Use the following options to further configure the deployment.

app Gleis application to upload to — type: string, default: repo name
username Gleis username — required, type: string
password Gleis password — required, secret, type: string
key_name Name of the SSH deploy key pushed to Gleis — type: string, default: dpl_deploy_key
verbose type: boolean

Shared options #

cleanup Clean up build artifacts from the Git working directory before the deployment — type: boolean
run Commands to execute after the deployment finished successfully — type: string or array of strings

Environment variables #

All options can be given as environment variables if prefixed with GLEIS_.

For example, password can be given as GLEIS_PASSWORD=<password>.

Securing secrets #

Secret option values should be given as either encrypted strings in your build configuration (.travis.yml file) or environment variables in your repository settings.

Environment variables can be set on the settings page of your repository, or using travis env set:

travis env set GLEIS_PASSWORD <password>

In order to encrypt option values when adding them to your .travis.yml file use travis encrypt:

travis encrypt <password>

Or use --add to directly add it to your .travis.yml file. Note that this command has to be run in your repository’s root directory:

travis encrypt --add deploy.password <password>

Pull Requests #

Note that pull request builds skip the deployment step altogether.

See also #