Travis CI Build Config Reference

Welcome to the Travis CI build config reference documentation.

You can find the build config in the .travis.yml file in your repository. This site documents its format.

The Travis CI build config format is formally specified using a JSON Schema. Travis CI uses this specification to normalize and validate build configs (this is currently in beta, and needs to be activated).

Use the Travis CI Build Config Explorer to explore and experiment with build config YAML snippets.

Keys

language — Language support to enable (type: enum (string), known values: android, c, clojure, cpp, crystal, csharp, d, dart, elixir, elm, ..., default: ruby, objective-c, e.g.: ruby) details
os — Build environment operating systems (type: sequence of enum (string), or enum (string), known values: linux, osx, windows, freebsd, linux-ppc64le, default: linux, osx) details
dist — Build environment distribution (type: enum (string), known values: trusty, precise, xenial, bionic, focal, jammy, server-2016, rhel8, default: xenial) details
arch — Build environment architectures (type: sequence of enum (string), or enum (string), known values: amd64, arm64, arm64-graviton2, ppc64le, i386, s390x) details
sudo — Whether to allow sudo access (deprecated, type: boolean, or string, e.g.: required) details
import — Build configuration imports (type: sequence of map, sequence of string, map, or string) details
env — Environment variables to set up (type: map, sequence of map, sequence of secure, sequence of string, secure, or string) details
compiler — Compilers to set up (type: sequence of string, or string) details
osx_image — (type: sequence of string, or string) details
stages — Build stages definition (type: sequence of map, sequence of string, map, or string) details
jobs — Build matrix definitions (type: map, sequence of job matrix includes, or job matrix includes, alias: matrix) details
notifications — Notification targets to notify on build results (type: map, sequence of map, sequence of sequence of secure, sequence of secure, sequence of boolean, secure, or boolean) details
version — Build config specification version (type: string, e.g.: >= 1.0.0) details
vm — VM size settings (type: vm, default: ``) details
perforce_test_path — Perforce depot subpath (type: string) details
vault — (type: vault) details

Shared keys

addons: Build addons to activate details
branches: Include or exclude branches from being built details
cache: Cache settings to speed up the build details
deploy: Deployment target configurations details
git: Git settings details
if: Condition to determine if a build, stage, or job should be run, a config source imported, or a notification sent details
services: Services to set up and start details
workspaces: Shared build workspaces details
keys: Custom keys to use details
before_install: Scripts to run before the install stage
install: Scripts to run at the install stage
before_script: Scripts to run before the script stage
script: Scripts to run at the script stage
before_cache: Scripts to run before storing a build cache
after_success: Scripts to run after a successful script stage
after_failure: Scripts to run after a failing script stage
before_deploy: Scripts to run before the deploy stage
after_deploy: Scripts to run after the deploy stage
after_script: Scripts to run as the last stage

Examples

vault:
  api_url: string
  token:
    secure: encrypted string
  secrets:
  - string
language: ruby
os:
- linux
- osx
dist: trusty

os: linux

Travis CI Build Config Reference

See also

Keys

Shared keys

Examples