Instantiate a CircleCI Job
A map of environment variable names and values.
The reusable executor to use for this job. The Executor must have already been instantiated and added to the config.
The name of the current Job.
Number of parallel instances of this job to run (defaults to 1 if undefined)
The list of parameters this job can accept.
Shell to use for execution command in all steps.
A list of Commands to execute within the job in the order which they were added.
In which directory to run the steps. Will be interpreted as an absolute path.
Add an environment variable to the job. This will be set in plain-text via the exported config file. Consider using project-level environment variables or a context for sensitive information.
Add steps to the current Job. Chainable.
Command to use for step
Define another parameter that this job will be able to accept. Chainable.
The name of the parameter.
The type of parameter being added to this job.
The default value of the parameter.
The description of the parameter.
The list of possible values for the parameter. type must be set to 'enum'.
this instance.
Generate Job schema
The generated JSON for the Job.
Generate the internal contents of this job.
The job contents in it's generated shape.
Generated using TypeDoc
Parameterized jobs are a type of Job which defines the parameters it can accept. This is the reusable alternative to the Job class, since parameters allow for more control and recyclability to the workflow.