Travis CI (.travis.yml)

Travis CI configuration file

File match .travis.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/travis-ci-travis-yml/latest.json
Source https://www.schemastore.org/travis.json

Validate with Lintel

npx @lintel/lintel check

All of

1. job object
2. object object
notifications object
8 nested properties
webhooks possiblySecretStringOrPossiblySecretStringTypeArrayUnique | boolean | webhooks | webhooks[]
slack slackRoom | boolean | slack | slack[]
email possiblySecretStringOrPossiblySecretStringTypeArrayUnique | boolean | email | email[]
irc possiblySecretStringOrPossiblySecretStringTypeArrayUnique | boolean | irc | irc[]
pushover nonEmptyStringOrArrayOfNonEmptyStrings | boolean | pushover | pushover[]
campfire possiblySecretStringOrPossiblySecretStringTypeArrayUnique | boolean | campfire | campfire[]
flowdock possiblySecretString | boolean | flowdock | flowdock[]
hipchat possiblySecretStringOrPossiblySecretStringTypeArrayUnique | boolean | hipchat | hipchat[]
matrix object
4 nested properties
exclude job[]
include job[]
allow_failures job[]
fast_finish boolean

If some rows in the build matrix are allowed to fail, the build won't be marked as finished until they have completed. To mark the build as finished as soon as possible, add fast_finish: true

jobs object
4 nested properties
include array
exclude array
allow_failures job[]
fast_finish boolean

If some rows in the build matrix are allowed to fail, the build won't be marked as finished until they have completed. To mark the build as finished as soon as possible, add fast_finish: true

stages string | object[]

Specifies the order of build stages

version string

Build config specification version

pattern=^(~>|>|>=|=|<=|<) (\d+(?:\.\d+)?(?:\.\d+)?)$
import import[] | import

Import YAML config snippets that can be shared across repositories.

Definitions

nonEmptyString string
notRequiredNonEmptyString nonEmptyString | null
arrayOfNonEmptyStrings nonEmptyString[]
nonEmptyStringOrArrayOfNonEmptyStrings nonEmptyString | arrayOfNonEmptyStrings
notRequiredNonEmptyStringOrArrayOfNonEmptyStrings nonEmptyStringOrArrayOfNonEmptyStrings | null
stringArrayUnique nonEmptyString[]
stringOrStringArrayUnique nonEmptyString | stringArrayUnique
stringOrNumber nonEmptyString | number
stringOrNumberAndBothAreTypeArrayUnique stringOrNumber[]
stringOrNumberOrAcceptBothTypeAsArrayUnique stringOrNumber | stringOrNumberAndBothAreTypeArrayUnique
secretString object
secure string
minLength=1
possiblySecretString string | object
possiblySecretStringOrPossiblySecretStringTypeArrayUnique possiblySecretString | possiblySecretString[]
slackRoom string | secretString

Your account name, token and optional channel

notificationFrequency enum
step boolean | enum | string | string[]
service enum
cache enum
xcodeVersions enum
envVars envVar | envVar[]
envVar string | object
job object
language enum
Values: "android" "bash" "c" "c++" "clojure" "cpp" "crystal" "csharp" "d" "dart" "dartlang" "elixir" "elm" "erlang" "generic" "go" "golang" "groovy" "haskell" "haxe" "java" "javascript" "julia" "jvm" "matlab" "minimal" "nix" "node" "node.js" "node_js" "nodejs" "obj-c" "obj_c" "objective-c" "objective_c" "perl" "perl6" "php" "python" "r" "ruby" "rust" "scala" "sh" "shell" "smalltalk"
matlab nonEmptyString | stringArrayUnique
elm nonEmptyString | stringArrayUnique
elm-test string
minLength=1
elm-format string
minLength=1
haxe string[]
scala string[]
sbt_args string
crystal string[]
neko string
hxml string[]
smalltalk string[]
perl string[]
perl6 string[]
d string[]
dart string[]
dart_task object[]
ghc string[]
lein string
android object
2 nested properties
components string[]
licenses string[]
node_js stringOrNumber | stringOrNumberAndBothAreTypeArrayUnique
compiler enum[] | enum
php stringOrNumber | stringOrNumberAndBothAreTypeArrayUnique
go string[] | string
jdk string | string[]
solution string

When the optional solution key is present, Travis will run NuGet package restore and build the given solution.

mono enum | string[]
xcode_project string
xcode_workspace string
xcode_scheme string
xcode_sdk string
podfile string

By default, Travis CI will assume that your Podfile is in the root of the repository. If this is not the case, you can specify where the Podfile is

python stringOrNumber | stringOrNumberAndBothAreTypeArrayUnique
elixir string[] | string
rust string[] | string | number
erlang string[] | string
julia stringOrNumber | stringOrNumberAndBothAreTypeArrayUnique
opt_release string[] | string
rvm stringOrNumber | stringOrNumberAndBothAreTypeArrayUnique
gemfile string | string[]
bundler_args string
r string[] | string
pandoc_version string
brew_packages string[]

A list of packages to install via brew. This option is ignored on non-OS X builds.

r_binary_packages string[]
r_packages string[]
bioc_packages string[]
r_github_packages string[]
apt_packages string[]
cran string

CRAN mirror to use for fetching packages

repos Record<string, string>

Dictionary of repositories to pass to options(repos)

arch enum | enum[]

The CPU Architecture to run the job on

os enum | enum[]

The operating system to run the job on

osx_image xcodeVersions | xcodeVersions[]
Default: "xcode9.4"
dist enum

The Ubuntu distribution to use

Values: "precise" "trusty" "xenial" "bionic" "focal" "jammy" "noble"
sudo enum

sudo is deprecated

Values: true false "" "required" "enabled"
addons object
16 nested properties
apt object

To install packages not included in the default container-based-infrastructure you need to use the APT addon, as sudo apt-get is not available

3 nested properties
update boolean

To update the list of available packages

sources object | string[]
packages string[]

To install packages from the package whitelist before your custom build steps

hosts string[] | string

If your build requires setting up custom hostnames, you can specify a single host or a list of them. Travis CI will automatically setup the hostnames in /etc/hosts for both IPv4 and IPv6.

ssh_known_hosts nonEmptyString | stringArrayUnique
artifacts enum | object
firefox string | nonEmptyString

Firefox addon

chrome string

Chrome addon

Values: "stable" "beta"
rethinkdb string

RethinkDB addon

postgresql string

PostgreSQL addon

mariadb string

MariaDB addon

sauce_connect object | boolean

Sauce Connect addon

sonarcloud object

SonarCloud addon

2 nested properties
organization string
token object
coverity_scan object

Coverity Scan addon

5 nested properties
project object

GitHub project metadata

notification_email string

Where email notification of build analysis results will be sent

build_command_prepend string

Commands to prepare for build_command

build_command string

The command that will be added as an argument to 'cov-build' to compile your project for analysis

branch_pattern string

Pattern to match selecting branches that will run analysis. We recommend leaving this set to 'coverity_scan'

homebrew object

Homebrew addon

5 nested properties
taps nonEmptyString | stringArrayUnique
packages nonEmptyString | stringArrayUnique
casks nonEmptyString | stringArrayUnique
brewfile nonEmptyString | boolean
update boolean
Default: true
srcclr boolean | object

SourceClear addon

snaps nonEmptyString | nonEmptyString | object[]

Snaps addon

browserstack object

BrowserStack addon

9 nested properties
username string
minLength=1
access_key string | object
app_path string
minLength=1
proxyHost string
minLength=1
proxyPort string
minLength=1
proxyUser string
minLength=1
proxyPass string
minLength=1
forcelocal boolean
only string
minLength=1
cache enum | cache | cache | object[] | object
services service | service[]
git object
7 nested properties
depth integer | enum
quiet boolean

Travis CI clones repositories without the quiet flag (-q) by default. Enabling the quiet flag can be useful if you're trying to avoid log file size limits or even if you just don't need to include it.

submodules boolean

Control whether submodules should be cloned

lfs_skip_smudge boolean

Skip fetching the git-lfs files during the initial git clone (equivalent to git lfs smudge --skip),

clone boolean

In some work flows, like build stages, it might be beneficial to skip the automatic git clone step.

sparse_checkout string
minLength=1
autocrlf boolean | string

Specify handling of line endings when cloning repository

branches object

Specify which branches to build

2 nested properties
except string[]
only string[]
env envVars | object
before_install boolean | enum | string | string[]
install boolean | enum | string | string[]
before_script boolean | enum | string | string[]
script boolean | enum | string | string[]
before_cache boolean | enum | string | string[]
after_success boolean | enum | string | string[]
after_failure boolean | enum | string | string[]
before_deploy boolean | enum | string | string[]
deploy deployment[] | deployment
after_deploy boolean | enum | string | string[]
after_script boolean | enum | string | string[]
deployment
import object | nonEmptyString
webhooks object
disabled boolean
enabled boolean
urls string | secretString | string | secretString[]
on_success enum
Values: "always" "never" "change"
on_failure enum
Values: "always" "never" "change"
on_start enum
Values: "always" "never" "change"
on_cancel enum
Values: "always" "never" "change"
on_error enum
Values: "always" "never" "change"
slack object
disabled boolean
enabled boolean
rooms slackRoom[]
minItems=1uniqueItems=true
on_pull_requests boolean
template nonEmptyStringOrArrayOfNonEmptyStrings | null
on_success enum
Values: "always" "never" "change"
on_failure enum
Values: "always" "never" "change"
on_start enum
Values: "always" "never" "change"
on_cancel enum
Values: "always" "never" "change"
on_error enum
Values: "always" "never" "change"
email object
disabled boolean
enabled boolean
recipients possiblySecretString | possiblySecretString[]
on_success enum
Values: "always" "never" "change"
on_failure enum
Values: "always" "never" "change"
on_start enum
Values: "always" "never" "change"
on_cancel enum
Values: "always" "never" "change"
on_error enum
Values: "always" "never" "change"
irc object
disabled boolean
enabled boolean
channels possiblySecretString | possiblySecretString[]
channel_key string | object
nick string
minLength=1
password string | object
template nonEmptyStringOrArrayOfNonEmptyStrings | null
on_success enum
Values: "always" "never" "change"
on_failure enum
Values: "always" "never" "change"
on_start enum
Values: "always" "never" "change"
on_cancel enum
Values: "always" "never" "change"
on_error enum
Values: "always" "never" "change"
skip_join boolean
use_notice boolean
pushover object
disabled boolean
enabled boolean
api_key string | object
users possiblySecretString | possiblySecretString[]
template nonEmptyStringOrArrayOfNonEmptyStrings | null
on_success enum
Values: "always" "never" "change"
on_failure enum
Values: "always" "never" "change"
on_start enum
Values: "always" "never" "change"
on_cancel enum
Values: "always" "never" "change"
on_error enum
Values: "always" "never" "change"
campfire object
disabled boolean
enabled boolean
rooms possiblySecretString | possiblySecretString[]
template nonEmptyString | arrayOfNonEmptyStrings
on_success enum
Values: "always" "never" "change"
on_failure enum
Values: "always" "never" "change"
on_start enum
Values: "always" "never" "change"
on_cancel enum
Values: "always" "never" "change"
on_error enum
Values: "always" "never" "change"
flowdock object
disabled boolean
enabled boolean
api_token string
minLength=1
on_success enum
Values: "always" "never" "change"
on_failure enum
Values: "always" "never" "change"
on_start enum
Values: "always" "never" "change"
on_cancel enum
Values: "always" "never" "change"
on_error enum
Values: "always" "never" "change"
hipchat object
disabled boolean
enabled boolean
notify boolean
on_pull_requests boolean
rooms possiblySecretString | possiblySecretString[]
format enum
Values: "html" "text"
template nonEmptyString | arrayOfNonEmptyStrings
on_success enum
Values: "always" "never" "change"
on_failure enum
Values: "always" "never" "change"
on_start enum
Values: "always" "never" "change"
on_cancel enum
Values: "always" "never" "change"
on_error enum
Values: "always" "never" "change"