CircleCI

Using Batect with CircleCI is straightforward. Recent machine executor images contain everything you need to use Batect.

You can see a full example of using Batect with CircleCI in the Golang sample project.

Environment#

tip

tl;dr: Use a machine executor with an image that has a recent version of Docker (eg. ubuntu-2004:202010-01).

CircleCI's recent machine executor images include everything Batect requires. All that needs to be done to use Batect with CircleCI is to configure it to use one of those machine executor images.

Adding the following to your .circleci/config.yml file instructs CircleCI to use a machine executor with the ubuntu-2004:202010-01 image, which contains everything Batect requires:

.circleci/config.yml

version: 2

jobs:
  build:
    machine:
      enabled: true
      image: ubuntu-2004:202010-01
    steps:
      - checkout
      - run: ./batect ...

Caching between builds#

If you're using caches, you can persist these between builds with the following configuration:

.circleci/config.yml

version: 2

jobs:
  build:
    machine:
      enabled: true
      image: ubuntu-2004:202010-01
    environment:
      BATECT_CACHE_TYPE: directory
    steps:
      - checkout
      - restore_cache:
          key: batect-caches-{{ arch }}-{{ checksum "path to a file that uniquely identifies the contents of the caches" }}
      -  # ...other build steps
      - save_cache:
          key: batect-caches-{{ arch }}-{{ checksum "path to a file that uniquely identifies the contents of the caches" }}
          paths:
            - .batect/caches

The key should be a value that changes when the contents of the cache change, and remains constant otherwise. A good candidate is the hash of a dependency lockfile, such as Gemfile.lock, package-lock.json, yarn.lock or go.sum. CircleCI's documentation for caching has more details on key.

Simplifying configuration#

CircleCI supports defining reusable commands within your configuration file. This can be useful if you find yourself running the same series of commands over and over again.

For example, if you have a series of jobs, each of which checks out your code, restores the cache, runs a Batect task and then saves the cache, you can define a command that contains all of these steps:

.circleci/config.yml

commands:
  batect:
    description: "Run a Batect task"
    parameters:
      task:
        type: string
    steps:
      - checkout
      - restore_cache:
          key: myproject-{{ checksum "yarn.lock" }}
      - run:
          command: ./batect << parameters.task >>
      - save_cache:
          key: myproject-{{ checksum "yarn.lock" }}
          paths:
            - node_modules/

...and then reuse it in each job:

.circleci/config.yml

build:
  machine: true
  image: ubuntu-2004:202010-01
  steps:
    - batect:
        task: build

test:
  machine: true
  image: ubuntu-2004:202010-01
  steps:
    - batect:
        task: test