Skip to content

CircleCI

An example YAML file for configuring Uplift to run on CircleCI. As Uplift is designed to push changes back to your GitHub repository, you will need to ensure CircleCI is granted write access to your repository.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# .circleci/config.yml

version: 2.1
workflows:
  main:
    jobs:
      - release:
          filters:
            branches:
              # Only trigger on the main branch
              only: main
jobs:
  release:
    docker:
      # Can use whatever base image you like
      - image: cimg/go:1.18
    steps:
      # Configure an SSH key that provides write access to your GitHub repository
      - add_ssh_keys:
          fingerprints:
            - "3b:c7:44:c9:34:ab:a4:fd:6c:33:4e:a7:7a:97:79:55" # (1)
      - checkout
      # Additional actions specified here
      - run: curl https://raw.githubusercontent.com/gembaadvantage/uplift/main/scripts/install | bash
      - run: uplift release
  1. By default, CircleCI will only have read-only access to your repository. For Uplift to work, write access is required. This can be achieved by accessing a repository as a machine-user and then loading its SSH key into the pipeline by its fingerprint