GitLab CI Include Resolution
Five include entries across the four include kinds — local path, local glob, another project at a pinned ref, a remote URL, and a bundled template. For testing include resolvers and dependency graphing without any file actually being fetched.
# Four include kinds in one document. A resolver has to distinguish local paths, another project's
# file at a ref, a remote URL, and a bundled template, and must not fetch anything to parse it.
include:
- local: /ci/templates/build.yml
- local: "/ci/templates/*.yml"
- project: example-org/ci-templates
ref: v3.2.0
file:
- /jobs/test.yml
- /jobs/lint.yml
- remote: "https://ci.example.invalid/shared/security.yml"
- template: Jobs/Code-Quality.gitlab-ci.yml
stages: [build, test, quality]
build:
extends: .shared_build
stage: build
lint:
extends: .shared_lint
stage: test
Specifications
- System
- GitLab CI
- Include Kinds
- 4
- Include Entries
- 5
- Remote Host
- ci.example.invalid
- Fetch Required
- false
Testing contract
Expected to pass- Scenario
- Enumerate a GitLab CI file's include graph without fetching remote content
- Expected result
- Five include entries resolve to four distinct kinds, the project include reports ref v3.2.0 and two files, and no network request is required to enumerate them
What is a .yml file?
YML is an alternate file extension for YAML, a human-readable data-serialization format based on indentation, key-value mappings, and lists. The content and parsing rules are identical to .yaml; only the extension differs. It is widely used for CI and application configuration files.
How to use this file
Use an example YML file to test that config loaders treat .yml and .yaml identically, and to exercise indentation, comment, and multi-document parsing.
How to use this file for testing
“GitLab CI Include Resolution” is a deterministic Novus Examples fixture for Config testing, Config parsing, Editor testing. TOML, INI, YAML, .env, and dotfile configuration samples with nested sections and typed values — for testing config parsers, loaders, and environment tooling.
Documented properties for this file: YML · 614 bytes. Compare results against paired or grouped companions on this page when present (clean↔damaged, searchable↔scanned, or format twins) so scores stay reproducible across runs.
Download the file once, keep the path stable in CI or local scripts, and treat the spec table as the contract: dimensions, seeds, field lists, and roles are intentional. Corrupt or invalid samples are labelled as such — expect parsers to fail loudly rather than silently accept them.
Pipeline and infrastructure fixtures are inert configuration: steps reference fictional images and scripts, and nothing here executes. Run your linter, schema validator, migrator, or policy engine against them, and expect the deprecated-syntax and intentionally invalid variants to be rejected.
Point your config loader at the file and assert it reads the documented sections and typed values, including any deliberately-tricky nesting or comments.
Code examples
import yaml # pip install pyyaml
with open("gitlab-ci-includes.yml") as f:
data = yaml.safe_load(f)
print(data)Related files
- ymlGitLab CI Child and Downstream TriggersDynamic child pipelines and a cross-project downstream trigger: one job generates a pipeline file as an artifact and a trigger job includes it, while a second trigger job starts a downstream project's pipeline with strategy: depend.
- ymlGitLab CI Deprecated only/except SyntaxA deprecated-syntax GitLab CI file using `only`/`except` in both the array and keyed forms, plus the long-retired `type:` keyword. For scoring a migrator that must rewrite all of it to `rules` and `stage`.
- ymlGitLab CI Parallel Matrix ExpansionBoth GitLab parallelisation forms in one file: a plain `parallel: 4` shard split and a `parallel: matrix` block whose two entries expand to seven combinations. Eleven jobs in total, documented so an expander can be checked exactly.
- ymlGitLab CI Rules and Workflow ConditionsRule-driven GitLab CI: a workflow block with four ordered conditions ending in `when: never`, plus job rules combining changes patterns, regex tag matching, a null-branch comparison, and a manual allow-failure fallback.
- ymlGitLab CI Stages, Needs, and ArtifactsA three-stage GitLab CI pipeline with a default block, global variables, artifact expiry, a needs-based DAG, and a coverage-extraction regex. The baseline the other GitLab fixtures vary from.
- yamlArgo CD Application with Sync PolicyAn Argo CD Application with automated sync, prune and self-heal, retry backoff, sync options, and an ignoreDifferences rule that exempts replica counts from drift detection. All Git and cluster endpoints are example.invalid.
Generated by generation/pipelines.py. Free for any use, no attribution required — license.