backstage/plugins/circleci/README.md

CircleCI Plugin

Website: https://circleci.com/

Setup

0. If you have standalone app (you didn't clone this repo), then do

yarn add @backstage/plugin-circleci

1. Add plugin API to your Backstage instance:

// packages/app/src/api.ts
import { ApiHolder } from '@backstage/core';
import { CircleCIApi, circleCIApiRef } from '@backstage/plugin-circleci';

const builder = ApiRegistry.builder();
builder.add(circleCIApiRef, new CircleCIApi(/* optional custom url for your own CircleCI instance */));

export default builder.build() as ApiHolder;

2. Add plugin itself:

// packages/app/src/plugins.ts
export { plugin as Circleci } from '@backstage/plugin-circleci';

3. Run app with yarn start and navigate to /circleci/settings
4. Enter project settings and project token, acquired according to https://circleci.com/docs/2.0/managing-api-tokens/

Features

• List top 50 builds for a project
• Dive into one build to see logs
• Polling
• Retry builds

Limitations

• Currently working only with project token (personal credentials WIP)
• Currently only top 50 builds in table view
• CircleCI has pretty strict rate limits per token, be careful with opened tabs