Specifying execution environment. While container execution is specified separately in GitHub,
docker is its own class of executor in CircleCI. |
# Choosing an Operating System
runs-on: ubuntu-latest # or windows, etc.
# If running steps on a container
container:
image: openjdk:17.0-jdk
| # Docker (container) Executor
docker:
- image: cimg/openjdk:17.0
# Linux Ubuntu Executor
machine:
image: ubuntu-2004:202010-01
# macOS Executor
macos:
xcode: 14.2.0
# Windows Executor
machine:
image: 'windows-server-2022-gui:current'
resource_class: windows.medium # can be medium, large, xlarge, 2xlarge
|
| Specifying dependencies/services. All images specified after the first in CircleCI are treated as dependencies. |
jobs:
build:
runs-on: ubuntu-latest
# Main container
container:
image: openjdk:17.0-jdk
# Dependency Service(s)
services:
postgres:
image: postgres:10.8
env:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: postgres
| jobs:
build:
docker:
# Primary Executor
- image: cimg/openjdk:17.0
# Dependency Service(s)
- image: postgres:10.8
environment:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: postgres
|
| Specifying steps to run in a job. Similar functionality, different syntax. |
jobs:
build:
# runner config here
steps:
- name: Build with Gradle
run: ./gradlew build
| jobs:
build:
# executor config here
steps:
- run:
name: Build with Gradle
command: ./gradlew build
|
Using shared tasks (Actions for GitHub, orbs for CircleCI). In CircleCI, you declare orbs at the top level
and then refer to them by name in config, similar in concept to Python or JavaScript imports. |
jobs:
build:
# runner config here
steps:
- name: Slack Notify
uses: rtCamp/action-slack-notify@v1.0.0
env:
SLACK_COLOR: '#32788D'
SLACK_MESSAGE: 'Tests passed'
SLACK_TITLE: Slack Notify GA
SLACK_USERNAME: Bobby
SLACK_WEBHOOK: # WEBHOOK
| orbs:
slack-orb: circleci/slack@3.4.0
jobs:
build:
# executor config here
steps:
- slack-orb/notify:
color: '#32788D'
message: Tests passed
title: Testing Slack Orb
author_name: Bobby
webhook: # WEBHOOK
|
Using conditional steps in the workflow. CircleCI offers the following: |
jobs:
build:
# environment config here
steps:
- name: My Failure Step
run: echo "Failed step"
if: failure()
- name: My Always Step
run: echo "Always step"
if: always()
| jobs:
build:
# executor config here
steps:
- run:
name: My Failure Step
command: echo "Failed step"
when: on_fail
- run:
name: My Always Step
command: echo "Always step"
when: always
|