Include a component twice#
Goal: run the same component more than once in one project, for example in a monorepo with two apps, and keep the two jobs separate. Set the job_name input on each include, as shown below.
Set job_name#
Every component takes a job_name input, whose default is the job's usual name. Set it when one project includes the same component more than once, for example in a monorepo with two apps; without it the two jobs would share a name and merge into one.
include:
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/pint@<full commit SHA> # <tag>
inputs:
working_dir: app
job_name: pint-app
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/pint@<full commit SHA> # <tag>
inputs:
working_dir: admin
job_name: pint-admin
Expected: the pipeline runs two separately named jobs, pint-app and pint-admin, instead of two jobs that merge into one.
Another use: the next PHP release#
Including a component twice is also how you try a PHP release before it is supported. Include php-test a second time for the release that is not supported yet, name that job, and let it fail. The name is what lets your own .gitlab-ci.yml loosen only that job:
include:
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/php-test@<full commit SHA> # <tag>
inputs:
php_versions: ["8.6"]
job_name: php-test-next
# While 8.6 only has release candidate images, name the tag: php:${PHP_VERSION}-rc-cli-trixie
# image: "php:${PHP_VERSION}-rc-cli-trixie"
php-test-next:
allow_failure: true
A red php-test-next job is an early warning, not a stop. Drop the allow_failure and move the version into the main php_versions list once the release is supported (the supported versions follow policy.json).
Related#
- The php-test component: inputs, caching, and the full next-release example.
- The portability component: include it once per app image, each with its own
job_name. - When the components run: the
workflow:rulesblock that belongs in the app's own file. - Reference: every component, with its inputs and defaults.