Class Job

Jobs define a collection of steps to be run within a given executor, and are orchestrated using Workflows.

Hierarchy

Component
- Job

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Job(name: string, executor: AbstractExecutor, steps?: Command[]): Job

Overrides Component.constructor
- Defined in src/lib/Components/Job/index.ts:29
Instantiate a CircleCI Job

see
https://circleci.com/docs/2.0/configuration-reference/?section=configuration#jobs

Parameters
- name: string
  
  Name your job with a unique identifier
- executor: AbstractExecutor
  
  The reusable executor to use for this job. The Executor must have already been instantiated and added to the config.
- Optional steps: Command[]
  
  A list of Commands to execute within the job in the order which they were added.
Returns Job

Properties

executor

executor: AbstractExecutor

The reusable executor to use for this job. The Executor must have already been instantiated and added to the config.

name

name: string

The name of the current Job.

steps

steps: Command[] = []

A list of Commands to execute within the job in the order which they were added.

Methods

addStep

addStep(command: Command): Job

- Defined in src/lib/Components/Job/index.ts:57
Add steps to the current Job. Chainable.

Parameters
- command: Command
  
  Command to use for step
Returns Job

generate

generate(): unknown

Overrides Component.generate
- Defined in src/lib/Components/Job/index.ts:39
Generate Job schema

Returns unknown
The generated JSON for the Job.

Generated using TypeDoc