[PATCH-for-5.2 2/2] gitlab-ci: Avoid running the EDK2 job when not necessary

Philippe Mathieu-Daudé posted 2 patches 5 years, 3 months ago
[PATCH-for-5.2 2/2] gitlab-ci: Avoid running the EDK2 job when not necessary
Posted by Philippe Mathieu-Daudé 5 years, 3 months ago
The EDK2 jobs use the 'changes' keyword, which "makes it
possible to define if a job should be created based on files
modified by a Git push event." (see [1]). This keyword comes
with a warning:

  Caution:

    In pipelines with sources other than the three above
    changes can’t determine if a given file is new or old
    and always returns true."

In commit 922febe2af we moved the YAML config file from the
repository root directory to the .gitlab-ci.d/ directory.

We didn't respect the previous warning and disabled the
'changes' filter rule, as the files are now in a (directory)
three above the YAML config file.

This jobs takes ~40min, and needlessly burns the 2000 minutes
available to GitLab free users. Follow the recommendations in
[3] and disable this job by default (except if we push a tag
or the branch contains 'edk2'). Note we do not remove the job
from the pipeline, it can still be triggered manually from the
WebUI.

[1] https://docs.gitlab.com/ee/ci/yaml/#onlychangesexceptchanges
[2] https://about.gitlab.com/releases/2020/03/18/ci-minutes-for-free-users/
[3] https://about.gitlab.com/pricing/faq-consumption-cicd/

Fixes: 922febe2af ("Move edk2 and opensbi YAML files to .gitlab-ci.d folder")
Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
---
 .gitlab-ci.d/edk2.yml | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)

diff --git a/.gitlab-ci.d/edk2.yml b/.gitlab-ci.d/edk2.yml
index e1e04524166..335c99035c9 100644
--- a/.gitlab-ci.d/edk2.yml
+++ b/.gitlab-ci.d/edk2.yml
@@ -1,10 +1,5 @@
 docker-edk2:
  stage: containers
- rules: # Only run this job when the Dockerfile is modified
- - changes:
-   - .gitlab-ci.d/edk2.yml
-   - .gitlab-ci.d/edk2/Dockerfile
-   when: always
  image: docker:19.03.1
  services:
  - docker:19.03.1-dind
@@ -26,13 +21,15 @@ docker-edk2:
 build-edk2:
  stage: build
  rules: # Only run this job when ...
- - changes: # ... roms/edk2/ is modified (submodule updated)
-   - roms/edk2/*
+ - if: $CI_COMMIT_TAG # we pushed a tag
    when: always
  - if: '$CI_COMMIT_REF_NAME =~ /^edk2/' # or the branch/tag starts with 'edk2'
    when: always
  - if: '$CI_COMMIT_MESSAGE =~ /edk2/i' # or last commit description contains 'EDK2'
    when: always
+   # ... else allow manual run on the WebUI
+ - when: manual
+   allow_failure: true
  artifacts:
    paths: # 'artifacts.zip' will contains the following files:
    - pc-bios/edk2*bz2
-- 
2.26.2

Re: [PATCH-for-5.2 2/2] gitlab-ci: Avoid running the EDK2 job when not necessary
Posted by Daniel P. Berrangé 5 years, 3 months ago
On Tue, Nov 10, 2020 at 01:16:06PM +0100, Philippe Mathieu-Daudé wrote:
> The EDK2 jobs use the 'changes' keyword, which "makes it
> possible to define if a job should be created based on files
> modified by a Git push event." (see [1]). This keyword comes
> with a warning:
> 
>   Caution:
> 
>     In pipelines with sources other than the three above
>     changes can’t determine if a given file is new or old
>     and always returns true."
> 
> In commit 922febe2af we moved the YAML config file from the
> repository root directory to the .gitlab-ci.d/ directory.
> 
> We didn't respect the previous warning and disabled the
> 'changes' filter rule, as the files are now in a (directory)
> three above the YAML config file.

This description is a bit wierd. I don't see how the location
in the directory tree has any relevance here.

IIUC the caution docs quoted above are referring to what triggered 
the pipeline. They're saying that if the trigger was not a "branch", 
"merge request", or "external pull request", then the "changes" rule 
always evaluates true.

The "branch" source us a bit wierd though, as I'm not seeing
how gitlab figures out which commits are "new" to the pipeline
and thus whether the files were modified or not.

Strangely qemu-project/qemu CI for master seems to be behaving
correctly and skipping the jobs.

Something is fishy here and clearly not working, so clearly
changes are needed, but the commit message is not explaining
it for me.

> This jobs takes ~40min, and needlessly burns the 2000 minutes
> available to GitLab free users. Follow the recommendations in
> [3] and disable this job by default (except if we push a tag
> or the branch contains 'edk2'). Note we do not remove the job
> from the pipeline, it can still be triggered manually from the
> WebUI.
> 
> [1] https://docs.gitlab.com/ee/ci/yaml/#onlychangesexceptchanges
> [2] https://about.gitlab.com/releases/2020/03/18/ci-minutes-for-free-users/
> [3] https://about.gitlab.com/pricing/faq-consumption-cicd/
> 
> Fixes: 922febe2af ("Move edk2 and opensbi YAML files to .gitlab-ci.d folder")
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
>  .gitlab-ci.d/edk2.yml | 11 ++++-------
>  1 file changed, 4 insertions(+), 7 deletions(-)
> 
> diff --git a/.gitlab-ci.d/edk2.yml b/.gitlab-ci.d/edk2.yml
> index e1e04524166..335c99035c9 100644
> --- a/.gitlab-ci.d/edk2.yml
> +++ b/.gitlab-ci.d/edk2.yml
> @@ -1,10 +1,5 @@
>  docker-edk2:
>   stage: containers
> - rules: # Only run this job when the Dockerfile is modified
> - - changes:
> -   - .gitlab-ci.d/edk2.yml
> -   - .gitlab-ci.d/edk2/Dockerfile
> -   when: always
>   image: docker:19.03.1
>   services:
>   - docker:19.03.1-dind
> @@ -26,13 +21,15 @@ docker-edk2:
>  build-edk2:
>   stage: build
>   rules: # Only run this job when ...
> - - changes: # ... roms/edk2/ is modified (submodule updated)
> -   - roms/edk2/*
> + - if: $CI_COMMIT_TAG # we pushed a tag
>     when: always
>   - if: '$CI_COMMIT_REF_NAME =~ /^edk2/' # or the branch/tag starts with 'edk2'
>     when: always
>   - if: '$CI_COMMIT_MESSAGE =~ /edk2/i' # or last commit description contains 'EDK2'
>     when: always
> +   # ... else allow manual run on the WebUI
> + - when: manual
> +   allow_failure: true
>   artifacts:
>     paths: # 'artifacts.zip' will contains the following files:
>     - pc-bios/edk2*bz2
> -- 
> 2.26.2
> 

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|


Re: [PATCH-for-5.2 2/2] gitlab-ci: Avoid running the EDK2 job when not necessary
Posted by Philippe Mathieu-Daudé 5 years, 3 months ago
On 11/10/20 4:35 PM, Daniel P. Berrangé wrote:
> On Tue, Nov 10, 2020 at 01:16:06PM +0100, Philippe Mathieu-Daudé wrote:
>> The EDK2 jobs use the 'changes' keyword, which "makes it
>> possible to define if a job should be created based on files
>> modified by a Git push event." (see [1]). This keyword comes
>> with a warning:
>>
>>   Caution:
>>
>>     In pipelines with sources other than the three above
>>     changes can’t determine if a given file is new or old
>>     and always returns true."
>>
>> In commit 922febe2af we moved the YAML config file from the
>> repository root directory to the .gitlab-ci.d/ directory.
>>
>> We didn't respect the previous warning and disabled the
>> 'changes' filter rule, as the files are now in a (directory)
>> three above the YAML config file.
> 
> This description is a bit wierd. I don't see how the location
> in the directory tree has any relevance here.
> 
> IIUC the caution docs quoted above are referring to what triggered 
> the pipeline. They're saying that if the trigger was not a "branch", 
> "merge request", or "external pull request", then the "changes" rule 
> always evaluates true.
> 
> The "branch" source us a bit wierd though, as I'm not seeing
> how gitlab figures out which commits are "new" to the pipeline
> and thus whether the files were modified or not.
> 
> Strangely qemu-project/qemu CI for master seems to be behaving
> correctly and skipping the jobs.

What about this one?

https://gitlab.com/berrange/qemu/-/jobs/827459510

> 
> Something is fishy here and clearly not working, so clearly
> changes are needed, but the commit message is not explaining
> it for me.
> 
>> This jobs takes ~40min, and needlessly burns the 2000 minutes
>> available to GitLab free users. Follow the recommendations in
>> [3] and disable this job by default (except if we push a tag
>> or the branch contains 'edk2'). Note we do not remove the job
>> from the pipeline, it can still be triggered manually from the
>> WebUI.


Re: [PATCH-for-5.2 2/2] gitlab-ci: Avoid running the EDK2 job when not necessary
Posted by Philippe Mathieu-Daudé 5 years ago
On 11/11/20 10:18 AM, Philippe Mathieu-Daudé wrote:
> On 11/10/20 4:35 PM, Daniel P. Berrangé wrote:
>> On Tue, Nov 10, 2020 at 01:16:06PM +0100, Philippe Mathieu-Daudé wrote:
>>> The EDK2 jobs use the 'changes' keyword, which "makes it
>>> possible to define if a job should be created based on files
>>> modified by a Git push event." (see [1]). This keyword comes
>>> with a warning:
>>>
>>>   Caution:
>>>
>>>     In pipelines with sources other than the three above
>>>     changes can’t determine if a given file is new or old
>>>     and always returns true."
>>>
>>> In commit 922febe2af we moved the YAML config file from the
>>> repository root directory to the .gitlab-ci.d/ directory.
>>>
>>> We didn't respect the previous warning and disabled the
>>> 'changes' filter rule, as the files are now in a (directory)
>>> three above the YAML config file.
>>
>> This description is a bit wierd. I don't see how the location
>> in the directory tree has any relevance here.
>>
>> IIUC the caution docs quoted above are referring to what triggered 
>> the pipeline. They're saying that if the trigger was not a "branch", 
>> "merge request", or "external pull request", then the "changes" rule 
>> always evaluates true.
>>
>> The "branch" source us a bit wierd though, as I'm not seeing
>> how gitlab figures out which commits are "new" to the pipeline
>> and thus whether the files were modified or not.
>>
>> Strangely qemu-project/qemu CI for master seems to be behaving
>> correctly and skipping the jobs.
> 
> What about this one?
> 
> https://gitlab.com/berrange/qemu/-/jobs/827459510

Ping?

> 
>>
>> Something is fishy here and clearly not working, so clearly
>> changes are needed, but the commit message is not explaining
>> it for me.
>>
>>> This jobs takes ~40min, and needlessly burns the 2000 minutes
>>> available to GitLab free users. Follow the recommendations in
>>> [3] and disable this job by default (except if we push a tag
>>> or the branch contains 'edk2'). Note we do not remove the job
>>> from the pipeline, it can still be triggered manually from the
>>> WebUI.


Re: [PATCH-for-5.2 2/2] gitlab-ci: Avoid running the EDK2 job when not necessary
Posted by Thomas Huth 5 years ago
On 17/01/2021 19.48, Philippe Mathieu-Daudé wrote:
> On 11/11/20 10:18 AM, Philippe Mathieu-Daudé wrote:
>> On 11/10/20 4:35 PM, Daniel P. Berrangé wrote:
>>> On Tue, Nov 10, 2020 at 01:16:06PM +0100, Philippe Mathieu-Daudé wrote:
>>>> The EDK2 jobs use the 'changes' keyword, which "makes it
>>>> possible to define if a job should be created based on files
>>>> modified by a Git push event." (see [1]). This keyword comes
>>>> with a warning:
>>>>
>>>>    Caution:
>>>>
>>>>      In pipelines with sources other than the three above
>>>>      changes can’t determine if a given file is new or old
>>>>      and always returns true."
>>>>
>>>> In commit 922febe2af we moved the YAML config file from the
>>>> repository root directory to the .gitlab-ci.d/ directory.
>>>>
>>>> We didn't respect the previous warning and disabled the
>>>> 'changes' filter rule, as the files are now in a (directory)
>>>> three above the YAML config file.
>>>
>>> This description is a bit wierd. I don't see how the location
>>> in the directory tree has any relevance here.
>>>
>>> IIUC the caution docs quoted above are referring to what triggered
>>> the pipeline. They're saying that if the trigger was not a "branch",
>>> "merge request", or "external pull request", then the "changes" rule
>>> always evaluates true.
>>>
>>> The "branch" source us a bit wierd though, as I'm not seeing
>>> how gitlab figures out which commits are "new" to the pipeline
>>> and thus whether the files were modified or not.
>>>
>>> Strangely qemu-project/qemu CI for master seems to be behaving
>>> correctly and skipping the jobs.
>>
>> What about this one?
>>
>> https://gitlab.com/berrange/qemu/-/jobs/827459510
> 
> Ping?

Daniel's comment sounded like there are some changes required here, at least 
to improve the commit message? So I was expecting a v2 here. Please clarify 
Daniel's concerns, then I can either pick up this version here or the v2 (in 
case you send one).

  Thomas


Re: [PATCH-for-5.2 2/2] gitlab-ci: Avoid running the EDK2 job when not necessary
Posted by Philippe Mathieu-Daudé 5 years ago
On 1/18/21 9:30 AM, Thomas Huth wrote:
> On 17/01/2021 19.48, Philippe Mathieu-Daudé wrote:
>> On 11/11/20 10:18 AM, Philippe Mathieu-Daudé wrote:
>>> On 11/10/20 4:35 PM, Daniel P. Berrangé wrote:
>>>> On Tue, Nov 10, 2020 at 01:16:06PM +0100, Philippe Mathieu-Daudé wrote:
>>>>> The EDK2 jobs use the 'changes' keyword, which "makes it
>>>>> possible to define if a job should be created based on files
>>>>> modified by a Git push event." (see [1]). This keyword comes
>>>>> with a warning:
>>>>>
>>>>>    Caution:
>>>>>
>>>>>      In pipelines with sources other than the three above
>>>>>      changes can’t determine if a given file is new or old
>>>>>      and always returns true."
>>>>>
>>>>> In commit 922febe2af we moved the YAML config file from the
>>>>> repository root directory to the .gitlab-ci.d/ directory.
>>>>>
>>>>> We didn't respect the previous warning and disabled the
>>>>> 'changes' filter rule, as the files are now in a (directory)
>>>>> three above the YAML config file.
>>>>
>>>> This description is a bit wierd. I don't see how the location
>>>> in the directory tree has any relevance here.
>>>>
>>>> IIUC the caution docs quoted above are referring to what triggered
>>>> the pipeline. They're saying that if the trigger was not a "branch",
>>>> "merge request", or "external pull request", then the "changes" rule
>>>> always evaluates true.
>>>>
>>>> The "branch" source us a bit wierd though, as I'm not seeing
>>>> how gitlab figures out which commits are "new" to the pipeline
>>>> and thus whether the files were modified or not.
>>>>
>>>> Strangely qemu-project/qemu CI for master seems to be behaving
>>>> correctly and skipping the jobs.
>>>
>>> What about this one?
>>>
>>> https://gitlab.com/berrange/qemu/-/jobs/827459510
>>
>> Ping?
> 
> Daniel's comment sounded like there are some changes required here, at
> least to improve the commit message? So I was expecting a v2 here.
> Please clarify Daniel's concerns, then I can either pick up this version
> here or the v2 (in case you send one).

Sorry, this "ping" was for Daniel. I'm not sure how to continue,
so shared an example in his namespace of "incorrect behavior".

Meanwhile I'm tempted to put those jobs in Manual mode (2 months now),
until we settle this with Daniel.

Thanks,

Phil.


Re: [PATCH-for-5.2 2/2] gitlab-ci: Avoid running the EDK2 job when not necessary
Posted by Daniel P. Berrangé 5 years ago
On Mon, Jan 18, 2021 at 10:26:15AM +0100, Philippe Mathieu-Daudé wrote:
> On 1/18/21 9:30 AM, Thomas Huth wrote:
> > On 17/01/2021 19.48, Philippe Mathieu-Daudé wrote:
> >> On 11/11/20 10:18 AM, Philippe Mathieu-Daudé wrote:
> >>> On 11/10/20 4:35 PM, Daniel P. Berrangé wrote:
> >>>> On Tue, Nov 10, 2020 at 01:16:06PM +0100, Philippe Mathieu-Daudé wrote:
> >>>>> The EDK2 jobs use the 'changes' keyword, which "makes it
> >>>>> possible to define if a job should be created based on files
> >>>>> modified by a Git push event." (see [1]). This keyword comes
> >>>>> with a warning:
> >>>>>
> >>>>>    Caution:
> >>>>>
> >>>>>      In pipelines with sources other than the three above
> >>>>>      changes can’t determine if a given file is new or old
> >>>>>      and always returns true."
> >>>>>
> >>>>> In commit 922febe2af we moved the YAML config file from the
> >>>>> repository root directory to the .gitlab-ci.d/ directory.
> >>>>>
> >>>>> We didn't respect the previous warning and disabled the
> >>>>> 'changes' filter rule, as the files are now in a (directory)
> >>>>> three above the YAML config file.
> >>>>
> >>>> This description is a bit wierd. I don't see how the location
> >>>> in the directory tree has any relevance here.
> >>>>
> >>>> IIUC the caution docs quoted above are referring to what triggered
> >>>> the pipeline. They're saying that if the trigger was not a "branch",
> >>>> "merge request", or "external pull request", then the "changes" rule
> >>>> always evaluates true.
> >>>>
> >>>> The "branch" source us a bit wierd though, as I'm not seeing
> >>>> how gitlab figures out which commits are "new" to the pipeline
> >>>> and thus whether the files were modified or not.
> >>>>
> >>>> Strangely qemu-project/qemu CI for master seems to be behaving
> >>>> correctly and skipping the jobs.
> >>>
> >>> What about this one?
> >>>
> >>> https://gitlab.com/berrange/qemu/-/jobs/827459510
> >>
> >> Ping?
> > 
> > Daniel's comment sounded like there are some changes required here, at
> > least to improve the commit message? So I was expecting a v2 here.
> > Please clarify Daniel's concerns, then I can either pick up this version
> > here or the v2 (in case you send one).
> 
> Sorry, this "ping" was for Daniel. I'm not sure how to continue,
> so shared an example in his namespace of "incorrect behavior".

Looking at pipelines than ran for me last week, I'm not seeing
ED2 being run, likewise for recent git master jobs on the main
repo.

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|