xref: /openbmc/qemu/docs/devel/ci-jobs.rst.inc (revision b91a0fa7)
1Custom CI/CD variables
2======================
3
4QEMU CI pipelines can be tuned by setting some CI environment variables.
5
6Set variable globally in the user's CI namespace
7------------------------------------------------
8
9Variables can be set globally in the user's CI namespace setting.
10
11For further information about how to set these variables, please refer to::
12
13  https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project
14
15Set variable manually when pushing a branch or tag to the user's repository
16---------------------------------------------------------------------------
17
18Variables can be set manually when pushing a branch or tag, using
19git-push command line arguments.
20
21Example setting the QEMU_CI_EXAMPLE_VAR variable:
22
23.. code::
24
25   git push -o ci.variable="QEMU_CI_EXAMPLE_VAR=value" myrepo mybranch
26
27For further information about how to set these variables, please refer to::
28
29  https://docs.gitlab.com/ee/user/project/push_options.html#push-options-for-gitlab-cicd
30
31Here is a list of the most used variables:
32
33QEMU_CI_AVOCADO_TESTING
34~~~~~~~~~~~~~~~~~~~~~~~
35By default, tests using the Avocado framework are not run automatically in
36the pipelines (because multiple artifacts have to be downloaded, and if
37these artifacts are not already cached, downloading them make the jobs
38reach the timeout limit). Set this variable to have the tests using the
39Avocado framework run automatically.
40
41AARCH64_RUNNER_AVAILABLE
42~~~~~~~~~~~~~~~~~~~~~~~~
43If you've got access to an aarch64 host that can be used as a gitlab-CI
44runner, you can set this variable to enable the tests that require this
45kind of host. The runner should be tagged with "aarch64".
46
47S390X_RUNNER_AVAILABLE
48~~~~~~~~~~~~~~~~~~~~~~
49If you've got access to an IBM Z host that can be used as a gitlab-CI
50runner, you can set this variable to enable the tests that require this
51kind of host. The runner should be tagged with "s390x".
52
53CENTOS_STREAM_8_x86_64_RUNNER_AVAILABLE
54~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55If you've got access to a CentOS Stream 8 x86_64 host that can be
56used as a gitlab-CI runner, you can set this variable to enable the
57tests that require this kind of host. The runner should be tagged with
58both "centos_stream_8" and "x86_64".
59