1. Patchew
  2. QEMU
  3. [PATCH-for-6.1 v4 0/4] gitlab-ci: Document custom CI/CD variables, fix 'when:' conditions
  4. View patch

[PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables

Philippe Mathieu-Daudé posted 4 patches 4 years, 6 months ago
There is a newer version of this series
[PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables
Posted by Philippe Mathieu-Daudé 4 years, 6 months ago 
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.
+
+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
+
+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'
-- 
2.31.1
Re: [PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables
Posted by Willian Rampazzo 4 years, 6 months ago 
On Mon, Jul 26, 2021 at 12:08 PM Philippe Mathieu-Daudé
<philmd@redhat.com> 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(-)
>

Reviewed-by: Willian Rampazzo <willianr@redhat.com>
Re: [PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables
Posted by Thomas Huth 4 years, 6 months ago 
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>
Re: [PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables
Posted by Philippe Mathieu-Daudé 4 years, 6 months ago 
On 7/27/21 7:59 AM, Thomas Huth wrote:
> 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" ?

OK.

> 
>> +
>> +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?

It will exist once this patch get merged, see [*] ;)

> 
>> +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>
>
Re: [PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables
Posted by Thomas Huth 4 years, 6 months ago 
On 27/07/2021 09.55, Philippe Mathieu-Daudé wrote:
> On 7/27/21 7:59 AM, Thomas Huth wrote:
>> 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" ?
> 
> OK.
> 
>>
>>> +
>>> +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?
> 
> It will exist once this patch get merged, see [*] ;)

The above URL points to the official gitlab documentation...

>>> 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.

... and not to the new one here. I think you mixed that up.

  Thomas
Re: [PATCH-for-6.1 v4 1/4] docs: Document GitLab custom CI/CD variables
Posted by Philippe Mathieu-Daudé 4 years, 6 months ago 
On 7/27/21 10:09 AM, Thomas Huth wrote:
> On 27/07/2021 09.55, Philippe Mathieu-Daudé wrote:
>> On 7/27/21 7:59 AM, Thomas Huth wrote:
>>> 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" ?
>>
>> OK.
>>
>>>
>>>> +
>>>> +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?
>>
>> It will exist once this patch get merged, see [*] ;)
> 
> The above URL points to the official gitlab documentation...
> 
>>>> 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.
> 
> ... and not to the new one here. I think you mixed that up.

Oops, thanks for double-checking!

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.