Circle CI logo

Backstage Circle CI Plugin

See Circle CI Builds in Backstage

Created by Spotify

Available on Roadie

Get SaaS Backstage

Don't want to spend your time installing and upgrading Backstage plugins? Get managed Backstage from Roadie.

Self-hosted Backstage installation steps

Install the plugin

yarn add @backstage/plugin-circleci

Import it into your Backstage application

// packages/app/src/components/catalog/EntityPage.tsx
import {
} from '@backstage/plugin-circleci';

Add the plugin to the CI/CD section

// packages/app/src/components/catalog/EntityPage.tsx
const cicdContent = (
    <EntitySwitch.Case if={isCircleCIAvailable}>
      <EntityCircleCIContent />

Add proxy configuration

# app-config.yaml
      Circle-Token: ${CIRCLECI_AUTH_TOKEN}

Get and provide a CIRCLECI_AUTH_TOKEN as an environment variable (see the CircleCI docs)

Add a annotation to your respective catalog-info.yaml files following the Component format

# Example catalog-info.yaml entity definition file
kind: Component
  # ...
    # This also supports bitbucket/xxx/yyy github/my-org/my-repo
  type: service
  # ...

Found a mistake? Update these instructions.

How it looks

A list of builds in a table along with a status and retry button for each build.

Become a Backstage expert

To get the latest news, deep dives into Backstage features, and a roundup of recent open-source action, sign up for Roadie's Backstage Weekly. See recent editions.

We will never sell or share your email address.