Scalingo Deployment

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 your application to Scalingo application after a successful build.

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

  provider: scalingo
  api_token: <api_token>
  edge: true # opt in to dpl v2

Alternatively, you can use username and password:

  provider: scalingo
  username: <username>
  password: <encrypted password>

Status #

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

Known options #

Use the following options to further configure the deployment. Either api_token or username and password are required.

app type: string, default: repo name
api_token Scalingo API token — type: string, alias: api_key (deprecated, please use api_token)
username Scalingo username — type: string
password Scalingo password — secret, type: string
region Scalingo region — type: string, default: agora-fr1, known values: agora-fr1, osc-fr1
remote Git remote name — type: string, default: scalingo-dpl
branch Git branch — type: string, default: master
timeout Timeout for Scalingo CLI commands — type: integer, default: 60

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 SCALINGO_.

For example, password can be given as SCALINGO_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 SCALINGO_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 #