Transifex 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 supports uploading to Transifex.

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

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

Alternatively, you can use username and password:

  provider: transifex
  username: <username>
  password: <encrypted password>

Status #

Support for deployments to Transifex 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.

api_token Transifex API token — secret, type: string
username Transifex username — type: string
password Transifex password — secret, type: string
hostname Transifex hostname — type: string, default:
cli_version CLI version to install — type: string, default: >=0.11

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

For example, api_token can be given as TRANSIFEX_API_TOKEN=<api_token>.

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 TRANSIFEX_API_TOKEN <api_token>

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

travis encrypt <api_token>

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

Pull Requests #

Note that pull request builds skip the deployment step altogether.

See also #