Install#
Preflight installs as an include: in the app's own .gitlab-ci.yml, one
line per component, pinned to a commit SHA with the tag in a trailing
comment. A tag or branch can move; a SHA cannot.
Requirements#
- GitLab 17.0 or newer. Components are GA on the Free tier since GitLab 17.0.
- Same instance only. Components work only within the same GitLab instance that hosts this project; they cannot be used across instances except by mirroring.
Install#
Add the include to the app's .gitlab-ci.yml:
All seven components
include:
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/proctor@fb73b538f3980292119b5b306ff64383d760a214 # 0.9.0
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/php-test@fb73b538f3980292119b5b306ff64383d760a214 # 0.9.0
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/composer-audit@fb73b538f3980292119b5b306ff64383d760a214 # 0.9.0
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/sbom@fb73b538f3980292119b5b306ff64383d760a214 # 0.9.0
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/pint@fb73b538f3980292119b5b306ff64383d760a214 # 0.9.0
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/phpstan@fb73b538f3980292119b5b306ff64383d760a214 # 0.9.0
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/eslint@fb73b538f3980292119b5b306ff64383d760a214 # 0.9.0
One component
include:
- component: $CI_SERVER_FQDN/enterprise-apps/preflight/php-test@fb73b538f3980292119b5b306ff64383d760a214 # 0.9.0
inputs:
test_command: vendor/bin/phpunit
Verify#
Push the change. The components are ordinary jobs, so they run whenever the
app's pipeline runs, and each one lands in the test stage by default.
Expected result: the pipeline shows the component's job, and for php-test
that is one job per entry of php_versions, 8.3, 8.4 and 8.5 by
default. A green job means the check passed.
Next steps#
- Quick start: the same install as numbered steps with expected results.
- When the components run: the
workflow:rulesblock that belongs in the app's own file. - The php-test component: inputs, caching, and trying the next PHP release.
- The a11y component: the accessibility gate for a site's pages, in 0.2.0.
- The squire-kit component: the check that a deploy kit still matches its Squire release, in 0.2.0.
- Reference: every component, with its inputs and defaults.
- The inputs contract: what a pin promises your includes, and how to see what moved before you move it.