CircleCI "parameter X is not declared" Error
Parameterized jobs, commands, and executors must declare every parameter they use under a parameters: key before referencing it with << parameters.NAME >>. Using an undeclared parameter fails validation.
What this error means
Config processing fails stating a parameter referenced in a job or command is not declared.
circleci
In job deploy, parameter env is not declared.
Declare it under the parameters key before using << parameters.env >>.Common causes
Parameter never declared
The reference << parameters.env >> has no matching entry under parameters:.
Declared in the wrong scope
A parameter declared on a command is not visible inside a different job.
Typo between declaration and use
The declared name and the referenced name differ.
How to fix it
Declare the parameter
Add the parameter with a type (and optional default) before referencing it.
.circleci/config.yml
jobs:
deploy:
parameters:
env:
type: string
default: staging
steps:
- run: ./deploy.sh << parameters.env >>How to prevent it
- Declare every parameter under the right scope before use.
- Match declared and referenced names exactly.
- Validate parameterized configs with the CircleCI CLI.
Frequently asked questions
What causes ""parameter" not declared"?
The reference << parameters.env >> has no matching entry under parameters:.
How do I fix "parameter" not declared?
Add the parameter with a type (and optional default) before referencing it.
Related guides
CircleCI "Cannot find a definition for command" ErrorFix CircleCI cannot find a definition for command X - the named reusable command is undefined, misspelled, or…
CircleCI "matrix parameters must be declared" ErrorFix CircleCI matrix errors where matrix parameters are not declared on the target job - every matrix key must…
CircleCI "when" Condition Invalid LogicFix CircleCI when/unless logic errors - malformed and/or/not/equal blocks, comparing against an unexpanded pa…