Job Matrix Includes
Jobs to include to the build matrix
Types
Keys
If given a map, the following keys are supported:
language
— Language support to enable (type: enum (string), known values:android
,c
,clojure
,cpp
,crystal
,csharp
,d
,dart
,elixir
,elm
,...
, e.g.:ruby
, see: Languages, Build Matrix)os
— (type: enum (string), known values:linux
,osx
,windows
,freebsd
,linux-ppc64le
)dist
— Build environment distribution (type: enum (string), known values:trusty
,precise
,xenial
,bionic
,focal
,jammy
,server-2016
,rhel8
, see: Virtualization environments)arch
— Build environment architecture (type: enum (string), known values:amd64
,arm64
,arm64-graviton2
,ppc64le
,i386
,s390x
)osx_image
— OSX image to use for the build environment (type: string)sudo
— Whether to allow sudo access (deprecated, type: boolean, or string, e.g.:required
)vm
— VM size settings (type: vm, see: Customizing the Build)env
— Environment variables to set up (type: sequence of map, sequence of secure, sequence of string, map, secure, or string)compiler
— (type: string, e.g.:gcc
)branches
— Include or exclude branches from being built (type: map, sequence of string, or string)name
— (type: string)stage
— (type: string)allow_failure
— (type: boolean)vault
— (type: vault)
Shared keys
addons
: Build addons to activate detailsbranches
: Include or exclude branches from being built detailscache
: Cache settings to speed up the build detailsdeploy
: Deployment target configurations detailsgit
: Git settings detailsif
: Condition to determine if a build, stage, or job should be run, a config source imported, or a notification sent detailsservices
: Services to set up and start detailsworkspaces
: Shared build workspaces detailskeys
: Custom keys to use detailsbefore_install
: Scripts to run before the install stageinstall
: Scripts to run at the install stagebefore_script
: Scripts to run before the script stagescript
: Scripts to run at the script stagebefore_cache
: Scripts to run before storing a build cacheafter_success
: Scripts to run after a successful script stageafter_failure
: Scripts to run after a failing script stagebefore_deploy
: Scripts to run before the deploy stageafter_deploy
: Scripts to run after the deploy stageafter_script
: Scripts to run as the last stage
Examples
include:
- vault:
api_url: string
token:
secure: encrypted string
secrets:
- string
language: ruby
os: linux
dist: trusty
include:
vault:
api_url: string
token:
secure: encrypted string
secrets:
- string
language: ruby
os: linux
dist: trusty