qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Thomas Huth <thuth@redhat.com>
To: "Philippe Mathieu-Daudé" <philmd@redhat.com>, qemu-devel@nongnu.org
Cc: "Bin Meng" <bmeng.cn@gmail.com>,
	"Daniel P . Berrangé" <berrange@redhat.com>
Subject: Re: [PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables
Date: Tue, 27 Jul 2021 07:59:54 +0200	[thread overview]
Message-ID: <09a71f22-2f9f-e8bd-148a-a8695af86f8f@redhat.com> (raw)
In-Reply-To: <20210726150429.1216251-2-philmd@redhat.com>

On 26/07/2021 17.04, Philippe Mathieu-Daudé wrote:
> We introduced the QEMU_CI_AVOCADO_TESTING variable in commit f56bf4caf
> ("gitlab: Run Avocado tests manually (except mainstream CI)"), but
> forgot to document it properly. Do it now.
> 
> Suggested-by: Thomas Huth <thuth@redhat.com>
> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
>   docs/devel/ci.rst | 40 ++++++++++++++++++++++++++++++++++++++++
>   .gitlab-ci.yml    | 19 ++-----------------
>   2 files changed, 42 insertions(+), 17 deletions(-)
> 
> diff --git a/docs/devel/ci.rst b/docs/devel/ci.rst
> index b3bf3ef615b..53df04afb7f 100644
> --- a/docs/devel/ci.rst
> +++ b/docs/devel/ci.rst
> @@ -8,6 +8,46 @@ found at::
>   
>      https://wiki.qemu.org/Testing/CI
>   
> +Custom CI/CD variables
> +======================
> +
> +QEMU CI pipelines can be tuned setting some CI environment variables.

"tuned *by* setting" ?

> +
> +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/#create-a-custom-variable-in-the-ui

The anchor does not seem to exist anymore?

> +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.
> +
>   Jobs on Custom Runners
>   ======================
>   
> diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
> index 6dc5385e697..9762dda2ee3 100644
> --- a/.gitlab-ci.yml
> +++ b/.gitlab-ci.yml
> @@ -16,24 +16,9 @@
>   # QEMU CI jobs are based on templates. Some templates provide
>   # user-configurable options, modifiable via configuration variables.
>   #
> -# These variables can be set globally in the user's CI namespace
> -# setting:
> -# https://docs.gitlab.com/ee/ci/variables/#create-a-custom-variable-in-the-ui
> -# or set manually each time a branch/tag is pushed, as a git-push
> -# command line argument:
> -# https://docs.gitlab.com/ee/user/project/push_options.html#push-options-for-gitlab-cicd
> +# See https://qemu-project.gitlab.io/qemu/devel/ci.html#custom-ci-cd-variables
> +# for more information.
>   #
> -# Example setting the QEMU_CI_EXAMPLE_VAR variable:
> -#
> -#   git push -o ci.variable="QEMU_CI_EXAMPLE_VAR=value" myrepo mybranch
> -#
> -# ----------------------------------------------------------------------
> -#
> -# List of environment variables that can be use to modify the set
> -# of jobs selected:
> -#
> -# - QEMU_CI_AVOCADO_TESTING
> -#   If set, tests using the Avocado framework will be run
>   
>   include:
>     - local: '/.gitlab-ci.d/qemu-project.yml'
> 

With the two issues above fixed:
Reviewed-by: Thomas Huth <thuth@redhat.com>



  parent reply	other threads:[~2021-07-27  6:01 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-26 15:04 [PATCH-for-6.1 v4 0/4] gitlab-ci: Document custom CI/CD variables, fix 'when:' conditions Philippe Mathieu-Daudé
2021-07-26 15:04 ` [PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables Philippe Mathieu-Daudé
2021-07-26 19:38   ` Willian Rampazzo
2021-07-27  5:59   ` Thomas Huth [this message]
2021-07-27  7:55     ` Philippe Mathieu-Daudé
2021-07-27  8:09       ` Thomas Huth
2021-07-27  8:32         ` Philippe Mathieu-Daudé
2021-07-26 15:04 ` [PATCH-for-6.1 v4 2/4] gitlab-ci: Fix 'when:' condition in acceptance_test_job_template Philippe Mathieu-Daudé
2021-07-26 19:39   ` Willian Rampazzo
2021-07-27  6:05   ` Thomas Huth
2021-07-26 15:04 ` [PATCH-for-6.1 v4 3/4] gitlab-ci: Fix 'when:' condition in EDK2 jobs Philippe Mathieu-Daudé
2021-07-26 19:40   ` Willian Rampazzo
2021-07-27  6:08   ` Thomas Huth
2021-07-26 15:04 ` [PATCH-for-6.1 v4 4/4] gitlab-ci: Fix 'when:' condition in OpenSBI jobs Philippe Mathieu-Daudé

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=09a71f22-2f9f-e8bd-148a-a8695af86f8f@redhat.com \
    --to=thuth@redhat.com \
    --cc=berrange@redhat.com \
    --cc=bmeng.cn@gmail.com \
    --cc=philmd@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --subject='Re: [PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).