gitlab-ci: Extract OpenSBI job rules and fix 'when' condition
PATCH v2 1/1 gitlab-ci: Extract OpenSBI job rules and fix 'when' condition
First, all jobs depending on 'docker-opensbi' job must use at most all the rules that triggers it. The simplest way to ensure that is to always use the same rules. Extract all the rules to a reusable section, and include this section (with the 'extends' keyword) in both 'docker-opensbi' and 'build-opensbi' jobs.
Second, jobs depending on another should not use the 'when: always' condition, because if a dependency failed we should not keep running jobs depending on it. The correct condition is 'when: on_success'.
The problems were introduced in commit c6fc0fc1a71 ("gitlab-ci.yml:
Add jobs to build OpenSBI firmware binaries"), but were revealed in commit 91e9c47e50a ("docker: OpenSBI build job depends on OpenSBI container").
This fix is similar to the one used with the EDK2 firmware job in commit ac0595cf6b3 ("gitlab-ci: Extract EDK2 job rules to reusable section").
---
v2: when 'always' -> 'on_success' & reworded (danpb)
Supersedes: <[email protected]>
--- .gitlab-ci.d/opensbi.yml | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-)
.gitlab-ci.d/opensbi.yml +18 -12
@@ -1,10 +1,23 @@ -docker-opensbi: - stage: containers - rules: # Only run this job when the Dockerfile is modified +# All jobs needing docker-opensbi must use the same rules it uses. +.opensbi_job_rules: + rules: # Only run this job when ... - changes: + # this file is modified - .gitlab-ci.d/opensbi.yml + # or the Dockerfile is modified - .gitlab-ci.d/opensbi/Dockerfile - when: always + when: on_success + - changes: # or roms/opensbi/ is modified (submodule updated) + - roms/opensbi/* + when: on_success + - if: '$CI_COMMIT_REF_NAME =~ /^opensbi/' # or the branch/tag starts with 'opensbi' + when: on_success + - if: '$CI_COMMIT_MESSAGE =~ /opensbi/i' # or last commit description contains 'OpenSBI' + when: on_success + +docker-opensbi: + extends: .opensbi_job_rules + stage: containers image: docker:19.03.1 services: - docker:19.03.1-dind
@@ -24,16 +37,9 @@ docker-opensbi: - docker push $IMAGE_TAG build-opensbi: + extends: .opensbi_job_rules stage: build needs: ['docker-opensbi'] - rules: # Only run this job when ... - - changes: # ... roms/opensbi/ is modified (submodule updated) - - roms/opensbi/* - when: always - - if: '$CI_COMMIT_REF_NAME =~ /^opensbi/' # or the branch/tag starts with 'opensbi' - when: always - - if: '$CI_COMMIT_MESSAGE =~ /opensbi/i' # or last commit description contains 'OpenSBI' - when: always artifacts: paths: # 'artifacts.zip' will contains the following files: - pc-bios/opensbi-riscv32-generic-fw_dynamic.bin
Signature · 1 line
2.31.1
Quoted 23 lines · Philippe Mathieu-Daudé
First, all jobs depending on 'docker-opensbi' job must use at most all the rules that triggers it. The simplest way to ensure that is to always use the same rules. Extract all the rules to a reusable section, and include this section (with the 'extends' keyword) in both 'docker-opensbi' and 'build-opensbi' jobs.
Second, jobs depending on another should not use the 'when: always' condition, because if a dependency failed we should not keep running jobs depending on it. The correct condition is 'when:
on_success'.The problems were introduced in commit
c6fc0fc1a71("gitlab-ci.yml:
Add jobs to build OpenSBI firmware binaries"), but were revealed in commit91e9c47e50a("docker: OpenSBI build job depends on OpenSBI container").This fix is similar to the one used with the EDK2 firmware job in commit
ac0595cf6b3("gitlab-ci: Extract EDK2 job rules to reusable section").Reported-by Daniel P. Berrangé <[email protected]>Reviewed-by Daniel P. Berrangé <[email protected]>Reviewed-by Willian Rampazzo <[email protected]>Signed-off-by Philippe Mathieu-Daudé <[email protected]>
Quoted 8 lines
---
v2: when 'always' -> 'on_success' & reworded (danpb)Supersedes: <[email protected]>
--- .gitlab-ci.d/opensbi.yml | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-)