aboutsummaryrefslogtreecommitdiff
path: root/docs/devel/ci-jobs.rst
diff options
context:
space:
mode:
authorDaniel P. Berrangé <berrange@redhat.com>2021-08-12 19:04:02 +0100
committerThomas Huth <thuth@redhat.com>2021-08-25 12:17:05 +0200
commit1ff4f90add806b6cb6ef1563e6e4ace1fae14548 (patch)
tree80c317e7801d3327fc0a5ccbd07c89fae81f7d68 /docs/devel/ci-jobs.rst
parent41f421e0b5821775ec9bd0cb55e534d0e8db7754 (diff)
downloadqemu-1ff4f90add806b6cb6ef1563e6e4ace1fae14548.zip
qemu-1ff4f90add806b6cb6ef1563e6e4ace1fae14548.tar.gz
qemu-1ff4f90add806b6cb6ef1563e6e4ace1fae14548.tar.bz2
docs: split the CI docs into two files
This splits the CI docs into one file talking about job setup and usage and another file describing provisioning of custom runners. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> Reviewed-by: Willian Rampazzo <willianr@redhat.com> Message-Id: <20210812180403.4129067-2-berrange@redhat.com> Signed-off-by: Thomas Huth <thuth@redhat.com>
Diffstat (limited to 'docs/devel/ci-jobs.rst')
-rw-r--r--docs/devel/ci-jobs.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/devel/ci-jobs.rst b/docs/devel/ci-jobs.rst
new file mode 100644
index 0000000..9cd9819
--- /dev/null
+++ b/docs/devel/ci-jobs.rst
@@ -0,0 +1,40 @@
+Custom CI/CD variables
+======================
+
+QEMU CI pipelines can be tuned by setting some CI environment variables.
+
+Set variable globally in the user's CI namespace
+------------------------------------------------
+
+Variables can be set globally in the user's CI namespace setting.
+
+For further information about how to set these variables, please refer to::
+
+ https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project
+
+Set variable manually when pushing a branch or tag to the user's repository
+---------------------------------------------------------------------------
+
+Variables can be set manually when pushing a branch or tag, using
+git-push command line arguments.
+
+Example setting the QEMU_CI_EXAMPLE_VAR variable:
+
+.. code::
+
+ git push -o ci.variable="QEMU_CI_EXAMPLE_VAR=value" myrepo mybranch
+
+For further information about how to set these variables, please refer to::
+
+ https://docs.gitlab.com/ee/user/project/push_options.html#push-options-for-gitlab-cicd
+
+Here is a list of the most used variables:
+
+QEMU_CI_AVOCADO_TESTING
+~~~~~~~~~~~~~~~~~~~~~~~
+By default, tests using the Avocado framework are not run automatically in
+the pipelines (because multiple artifacts have to be downloaded, and if
+these artifacts are not already cached, downloading them make the jobs
+reach the timeout limit). Set this variable to have the tests using the
+Avocado framework run automatically.
+