Configure For CircleCI

Configuration

To configure a project for CircleCI you need to configure the BuildBasis orb for your repository.

Prerequisite:

Configuring any project to report data to BuildBasis requires an API key. You can view your organization’s API key in the BuildBasis Dashboard API Page.

Steps:

1.) Set a BUILDBASIS_API_KEY environment variable in CircleCI to an api key from your BuildBasis dashboard.

2.) Add the BuildBasis orb to your project’s /.circleci/config.yml file.

orbs:
  buildbasis: buildbasis/buildbasis@1.0.0

3.) Add the start step to the beginning of your build steps.

  buildbasis/start

4.) Add the finish step at the end of your build steps.

  buildbasis/finish

5.) Run a pipeline and the project will be viewable within BuildBasis.

This is a more complete example of a CircleCI config successfully integrating with BuildBasis:

version: 2.1


orbs:
  ruby: circleci/ruby@0.1.2
  buildbasis: buildbasis/buildbasis@1.0.0
jobs:
  build:
    docker:
      - image: circleci/ruby:2.6.3-stretch-node
    steps:
      - checkout
      - buildbasis/start
      - run: gem install bundler -v 2.1.0.pre.3
      - run: bundle install
      - run: bundle exec rspec
      - buildbasis/finish