@backstage/plugin-circleci
TypeScript icon, indicating that this package has built-in type declarations

0.3.33 • Public • Published

CircleCI Plugin

[!IMPORTANT] This plugin is now developed & maintained by CircleCI. Please refer to their up-to-date documentation & plugin repository for help.

Screenshots

Setup

  1. If you have a standalone app (you didn't clone this repo), then do
# From your Backstage root directory
yarn --cwd packages/app add @circleci/backstage-plugin
  1. Add the EntityCircleCIContent extension to the entity page in your app:
// In packages/app/src/components/catalog/EntityPage.tsx
import {
  EntityCircleCIContent,
  isCircleCIAvailable,
} from '@circleci/backstage-plugin';

// For example in the CI/CD section
const cicdContent = (
  <EntitySwitch>
    <EntitySwitch.Case if={isCircleCIAvailable}>
      <EntityCircleCIContent />
    </EntitySwitch.Case>
  1. Add proxy config:
# In app-config.yaml
proxy:
  '/circleci/api':
    target: https://circleci.com/api/v1.1
    headers:
      Circle-Token: ${CIRCLECI_AUTH_TOKEN}
  1. Get and provide a CIRCLECI_AUTH_TOKEN as an environment variable (see the CircleCI docs).
  2. Add an annotation to your respective catalog-info.yaml files, with the format circleci.com/project-slug: <git-provider>/<owner>/<project> (See reference in ADR002).
# Example catalog-info.yaml entity definition file
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  # ...
  annotations:
    # This also supports bitbucket/xxx/yyy
    circleci.com/project-slug: github/my-org/my-repo
spec:
  type: service
  # ...

Features

  • List top 50 builds for a project
  • Dive into one build to see logs
  • Polling (logs only)
  • Retry builds
  • Works for both project and personal tokens
  • Pagination for builds

Limitations

  • CircleCI has pretty strict rate limits per token, be careful with opened tabs
  • CircleCI doesn't provide a way to auth by 3rd party (e.g. GitHub) token, nor by calling their OAuth endpoints, which currently stands in the way of better auth integration with Backstage (reference feature request and discussion topic)

Readme

Keywords

Package Sidebar

Install

npm i @backstage/plugin-circleci

Homepage

backstage.io

Weekly Downloads

1,553

Version

0.3.33

License

Apache-2.0

Unpacked Size

136 kB

Total Files

6

Last publish

Collaborators

  • patriko
  • freben
  • marcuseide