Orbs, Jobs, Steps, and Workflows
The document provides an overview of Jobs, Steps, Workflows and new
.circleci/config.yml keys for Orbs.
- Orbs Overview
- Jobs Overview
- Steps Overview
- Sample Configuration with Imported Orb
- Sample Configuration with Concurrent Jobs
- See Also
Orbs are packages of config that you either import by name or configure inline to simplify your config, share, and reuse config within and across projects. See Using Orbs for details about how to use orbs in your config and an introduction to orb design. Visit the Orbs Registry to search for orbs to help simplify your config.
Jobs are a collection of Steps. All of the steps in the job are executed in a single unit which consumes a CircleCI container from your plan while it’s running.
Jobs and Steps enable greater control and provide a framework for workflows and status on each phase of a run to report more frequent feedback. The following diagram illustrates how data flows between jobs. Workspaces persist data between jobs in a single Workflow. Caching persists data between the same job in different Workflow builds. Artifacts persist data after a Workflow has finished.
In 2.0 Jobs can be run using the
machine executor which enables reuse of recently used
machine executor runs, or the
docker executor which can compose Docker containers to run your tests and any services they require, such as databases, or the
When using the
docker executor the container images listed under the
docker: keys specify the containers to start. Any public Docker images can be used with the
See the Specifying Container Images document for more information about
machine use cases and comparisons.
Steps are a collection of executable commands which are run during a job, the
checkout: key is required to checkout your code and a key for
run: enables addition of arbitrary, multi-line shell command scripting. In addition to the
run: key, keys for
add_ssh_keys are nested under Steps.
Sample Configuration with Imported Orb
version: 2.1 orbs: aws-s3: firstname.lastname@example.org #imports the s3 orb in the circleci namespace workflows: build-test-deploy: jobs: - deploy2s3: # a sample job that would be defined above. steps: - aws-s3/sync: #invokes the sync command declared in the s3 orb from: . to: "s3://mybucket_uri" overwrite: true
Sample Configuration with Concurrent Jobs
Following is a sample 2.0
version: 2 jobs: build: docker: - image: circleci/<language>:<version TAG> steps: - checkout - run: <command> test: docker: - image: circleci/<language>:<version TAG> steps: - checkout - run: <command> workflows: version: 2 build_and_test: jobs: - build - test
This example shows a concurrent job workflow where the
test jobs run concurrently to save time. Refer to the Workflows document for complete details about orchestrating job runs with concurrent, sequential, and manual approval workflows.