Task defines where and how your scripts will be executed. Let's check line-by-line an example of
.cirrus.yml configuration file first:
task: container: image: gradle:4.3.0-jdk8 cpu: 4 memory: 10G script: gradle test
Example above defines a single task that will be scheduled and executed on Community Cluster using
gradle:4.3.0-jdk8 Docker image.
Only one user defined script instruction to run
gradle test will be executed. Pretty simple, isn't it?
Please read topics below if you want better understand what's doing on in a more complex
.cirrus.yml configuration file like this:
# global default container: image: node:latest lint_task: node_modules_cache: folder: node_modules fingerprint_script: cat yarn.lock populate_script: yarn install test_script: yarn run lint test_task: container: matrix: image: node:latest image: node:8.3.0 node_modules_cache: folder: node_modules fingerprint_script: cat yarn.lock populate_script: yarn install test_script: yarn run test publish_task: depends_on: - test - lint only_if: $BRANCH == "master" node_modules_cache: folder: node_modules fingerprint_script: cat yarn.lock populate_script: yarn install publish_script: yarn run publish
script instruction executes commands via
shell on Unix or
batch on Windows.
script instruction can be named by
adding a name as a prefix. For example
my_very_specific_build_step_script. Naming script instructions
helps gather more granular information about task execution. Cirrus CI will use it in future to auto-detect performance
Script commands can be specified as a single string value or a list of string values in
.cirrus.yml configuration file
like in an example below:
check_task: compile_script: gradle --parallel classes testClasses check_script: - printenv - gradle check
Background Script Instruction¶
background_script instruction is absolutely the same as
script instruction but Cirrus CI won't wait for the script to finish
and will continue execution of following instructions.
Background scripts can be useful when something needs to be executed in the background. For example, a database or
some emulators. Traditionally the same effect is achieved by adding
& to a command like
$: command &. Problem here
is that logs from
command will be mixed into regular logs of the following commands. By using background scripts
not only logs will be properly saved and displayed, but also
command itself will be properly killed in the end of a task.
Here is an example of how
background_script instruction can be used to run an android emulator:
android_test_task: start_emulator_background_script: emulator -avd test -no-audio -no-window wait_for_emulator_to_boot_script: adb wait-for-device test_script: gradle test
cache instruction allows to save some folder in cache based on a fingerprint and reuse it during the next execution
of the task with the same fingerprint.
cache instruction can be named the same way as
Here is an example:
test_task: node_modules_cache: folder: node_modules fingerprint_script: cat yarn.lock populate_script: yarn install test_script: yarn run test
fingerprint_script is an optional field that can specify a script that will be executed and console output of which
will be used as a fingerprint for the given task. By default task name is used as a fingerprint value.
fingerprint_script is an optional field that can specify a script that will be executed to populate the cache.
populate_script should create
Note that a cache folder will be archived and uploaded only in the very end of the task execution once all instructions succeed.
Which means the only difference between example above and below is that
yarn install will always be executed in the
example below where in the example above only when
yarn.lock has changes.
test_task: node_modules_cache: folder: node_modules fingerprint_script: cat yarn.lock install_script: yarn install test_script: yarn run test
Environment variables can be configured under
env keyword in
.cirrus.yml file. Here is an example:
echo_task: env: FOO: Bar echo_script: echo $FOO
Also some default environment variables are pre-defined:
|Name||Value / Description|
|CIRRUS_BRANCH||Branch name. For example
|CIRRUS_PR||PR number if current build was triggered by a PR based of a fork. For example
|CIRRUS_TAG||Tag name if current build was triggered by a new tag. For example
|CIRRUS_BUILD_ID||Unique build ID|
|CIRRUS_TASK_ID||Unique task ID|
|CIRRUS_REPO_NAME||Repository name. For example
|CIRRUS_REPO_OWNER||Repository owner(an organization or a user). For example
|CIRRUS_REPO_FULL_NAME||Repository full name. For example
|CIRRUS_REPO_CLONE_URL||URL used for cloning. For example
|CIRRUS_WORKING_DIR||Working directory where|
|CIRRUS_HTTP_CACHE_HOST||Host and port number on which local HTTP cache can be accessed on|
It is possible to securely add sensitive information to
.cirrus.yml file. Encrypted variables are only available to
builds initialized or approved by users with write permission to a corresponding repository.
In order to encrypt a variable go to repository's settings page via clicking settings icon on a repository's main page (for example https://cirrus-ci.org/github/my-organization/my-repository) and follow instructions.
Only users with
WRITE permissions can add encrypted variables to a repository.
An encrypted variable will be presented in a form like
ENCRYPTED[qwerty239abc] which can be safely committed to
publish_task: environemnt: AUTH_TOKEN: ENCRYPTED[qwerty239abc] script: ./publish.sh
Cirrus CI encrypts variables with a unique per repository 256-bit encryption key so forks and even repositories within
the same organization cannot re-use them.
qwerty239abc from the example above is NOT the content of your encrypted
variable, it's just an internal ID. No one can brute force your secrets from such ID.
Sometimes it's useful to run the same task against different software versions. Or run different batches of tests based
on an environment variable. For cases like these
matrix modification comes very handy. It's possible to use
keyword anywhere inside of a particular task to have multiple tasks based on the original one. Each new task will be created
from the original task by replacing the whole
matrix YAML node with each
matrix's children separately.
Let check an example of
test_task: container: matrix: image: node:latest image: node:8.3.0 test_script: yarn run test
Which will be expanded into:
test_task: container: image: node:latest test_script: yarn run test test_task: container: image: node:8.3.0 test_script: yarn run test
matrix modification can be used multiple times within a task.
matrix modification makes it easy to create some pretty complex testing scenarios like this:
test_task: container: matrix: image: node:latest image: node:8.3.0 env: matrix: COMMAND: test COMMAND: lint node_modules_cache: folder: node_modules fingerprint_script: - node --version - cat yarn.lock populate_script: yarn install test_script: yarn run $COMMAND
Sometimes it might be very handy execute some tasks only after successful execution of other tasks. For such cases
it's possible specify for a task names of other tasks it depends on with
lint_task: script: yarn run lint test_task: script: yarn run test publish_task: depends_on: - test - lint script: yarn run publish
Conditional Task Execution¶
Some tasks are meant to be executed for master or release branches only. In order to specify a condition when a task
should be executed please use
publish_task: only_if: $CIRRUS_BRANCH == 'master' script: yarn run publish
Currently only basic operators like
|| and unary
! are supported in
Environment variables can also be used as usually.
For the most cases regular caching mechanism where Cirrus CI caches a folder is more than enough. But modern build systems like Gradle, Bazel and Pants can take advantages of remote caching. Remote caching is when a build system uploads and downloads intermediate results of a build execution while the build itself is still executing.
Cirrus CI agent starts a local caching server and exposes it via
CIRRUS_HTTP_CACHE_HOST environments variable. Caching server
HEAD requests to upload, download and check presence of artifacts.
12321 is available
CIRRUS_HTTP_CACHE_HOST will be equal to
For example running the following command:
curl -s -X POST --email@example.com http://$CIRRUS_HTTP_CACHE_HOST/mykey
Has the same effect as a caching instruction of
myfolder folder where
sha1sum of all the
myfolder contents is equal to
myfolder_cache: folder: myfolder
To see how HTTP Cache can be used with Gradle's Build Cache please check this example.
Sometimes one container is not enough to run a CI build. For example, your application might use a MySQL database as a storage. In this case you most likely want a MySQL instance running for your tests.
One option here is to pre-install MySQL and use a
background_script to start it. This
approach has some inconveniences like the need to pre-install MySQL by building a custom Docker container.
For such use cases Cirrus CI allows to run additional containers in parallel with the main container that executes a task.
Each additional container is defined under
additional_containers keyword in
.cirrus.yml. Each additional container
should have a unique
name and specify at least Docker
port that this container exposes.
In the example below we are going to use an official MySQL Docker image that exposes
the standard MySQL port (3306). Tests will be able to access MySQL instance via
container: image: golang:1.9.4 additional_containers: - name: mysql image: mysql:8 port: 3306 cpu: 1.0 memory: 512Mi env: MYSQL_ROOT_PASSWORD: ""
Additional container can be very handy in many scenarios. Please check Cirrus CI catalog of examples for more details.
Cirrus CI provides a way to embed a badge that can represent status of your builds into a ReadMe file or a website.
In order to embed such a check into your ReadMe file or your website, simply use a URL to a badge that looks like this:
https://api.cirrus-ci.com/github/<USER OR ORGANIZATION>/<REPOSITORY>.svg
If you want a badge for a particular branch, simply use
?branch=<BRANCH NAME> query parameter like this:
https://api.cirrus-ci.com/github/<USER OR ORGANIZATION>/<REPOSITORY>.svg?branch=<BRANCH NAME>
Badges in Markdown¶
Here is how Cirrus CI's badge can be embeded in a Markdown file:
[![Build Status](https://api.cirrus-ci.com/github/<USER OR ORGANIZATION>/<REPOSITORY>.svg)](https://cirrus-ci.com/github<USER OR ORGANIZATION>/<REPOSITORY>)