Environment Variables

DEBUG

Set to * to get a lot of debug information. See Showing debug output for more.

CI

See Environment checks.

CIRCLECI

Used to check if this is a Circle CI environment.

FRIGG

Used to check if this is a Frigg environment.

SEMAPHORE

Used to check if this is a Semaphore environment.

TRAVIS

Used to check if this is a Travis CI environment.

GITLAB_CI

Used to check if this is a GitLab CI environment.

CI_SERVER_HOST

Host component of the GitLab instance URL, without protocol and port. Example: gitlab.example.com

Note

Automatically set in a GitLab CI environment from version 12.1.

Authentication

GH_TOKEN

A personal access token from GitHub. This is used for authenticating when pushing tags, publishing releases etc. See Configuring push to Github for usage.

To generate a token go to https://github.com/settings/tokens and click on Personal access token.

GL_TOKEN

A personal access token from GitLab. This is used for authenticating when pushing tags, publishing releases etc.

PYPI_TOKEN

Set an API token for publishing to https://pypi.org/. Information on how to obtain a token is given here.

See Configuring pypi upload for more about PyPI uploads.

PYPI_PASSWORD

Used together with PYPI_USERNAME when publishing to https://pypi.org/.

Warning

You should use PYPI_TOKEN instead of username and password authentication for the following reasons:

  • It is strongly recommended by PyPI.
  • Tokens can be given access to only a single project, which reduces the possible damage if it is compromised.
  • You can change your password without having to update it in CI settings.
  • If your PyPI username is the same as your GitHub and you have it set as a secret in a CI service, they will likely scrub it from the build output. This can break things, for example repository links.

PYPI_USERNAME

Used together with PYPI_PASSWORD when publishing to https://pypi.org/.