CircleCI Reusable Commands and Parameters
A reusable CircleCI command with string and boolean parameters, a conditional `when` step, and a job parameterised by an enum expanded through a workflow matrix. Exercises CircleCI's << >> template syntax, which is not YAML and not Jinja.
version: 2.1
commands:
install-and-cache:
description: Install dependencies with a parameterised cache key
parameters:
cache-prefix:
type: string
default: deps
run-audit:
type: boolean
default: false
steps:
- restore_cache:
keys:
- << parameters.cache-prefix >>-{{ checksum "package-lock.json" }}
- run: npm ci
- when:
condition: << parameters.run-audit >>
steps:
- run: npm run check-deps
jobs:
verify:
parameters:
suite:
type: enum
enum: [unit, integration, contract]
docker:
- image: registry.example.invalid/ci/node:20
steps:
- checkout
- install-and-cache:
cache-prefix: verify
run-audit: true
- run: npm run test:<< parameters.suite >>
workflows:
verify-all:
jobs:
- verify:
name: verify-<< matrix.suite >>
matrix:
parameters:
suite: [unit, integration, contract]
Specifications
- System
- CircleCI
- Commands
- 1
- Parameter Types
- string, boolean, enum
- Template Syntax
- << parameters.x >>
- Matrix Combinations
- 3
Testing contract
Expected to pass- Scenario
- Resolve CircleCI's << parameters.x >> template syntax and expand an enum matrix
- Expected result
- Every << >> reference binds to a declared parameter and the matrix expands to 3 named jobs
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
“CircleCI Reusable Commands and Parameters” 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 · 1,041 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("circleci-parameters-commands.yml") as f:
data = yaml.safe_load(f)
print(data)Related files
- ymlCircleCI Config with Cache and WorkspaceA CircleCI 2.1 config with a two-job workflow, a fallback cache-key list, workspace persistence between jobs, and a test-results store. The baseline the other CircleCI fixtures vary from.
- ymlCircleCI Orbs and Named ExecutorsCircleCI orbs and reusable named executors: two orb imports, two executors at different resource classes, an orb-provided step, and a branch filter combining an exact name with a regex.
- ymlCircleCI Workflow Matrix with ExcludeA CircleCI workflow matrix across three operating systems and two Go versions with one exclusion, plus a tag filter regex. Six combinations minus one is five jobs, documented so an expansion can be scored exactly.
- 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.
- yamlArgo CronWorkflow ScheduleAn Argo CronWorkflow wrapping an inline workflowSpec: a cron schedule with an explicit timezone, Replace concurrency, history limits, and a suspend flag. Nested-spec shape that flat schedule extractors miss.
- ymlAzure Pipelines Matrix StrategyAzure's named-leg matrix form, where each leg is a mapping of variables rather than an axis product: three Python legs, a maxParallel cap, a job timeout, and a JUnit results publish step that runs on failure too.
Generated by generation/pipelines.py. Free for any use, no attribution required — license.