Backstage Buildkite Plugin

Set up Backstage in minutes with Roadie

Focus on using Backstage, rather than building and maintaining it.

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

Installation steps

Install the plugin

yarn add @roadiehq/backstage-plugin-buildkite

Add proxy configurations

# app-config.yaml
proxy:
  '/buildkite/api':
    target: https://api.buildkite.com/v2/
    headers:
      Authorization: Bearer ${BUILDKITE_TOKEN}

Import it into your Backstage application

// packages/app/src/components/catalog/EntityPage.tsx
import {
  EntityBuildkiteContent,
  isBuildkiteAvailable,
} from '@roadiehq/backstage-plugin-buildkite';

Add plugin API to your Backstage instance

// packages/app/src/components/catalog/EntityPage.tsx

export const cicdContent = (
  <EntitySwitch>
    <EntitySwitch.Case if={isBuildkiteAvailable}>
      <EntityBuildkiteContent />
    </EntitySwitch.Case>
    ...
  </EntitySwitch>
);

Add annotation to your component-info.yaml file

metadata:
  annotations:
    buildkite.com/project-slug: <buildkiteorganization/buildkitepipeline>

Get and provide BUILDKITE_TOKEN as env variable.

Found a mistake? Update these instructions.

Things to know

Features

You might rebuild each build and track build progress with this plugin.

Set up Backstage in minutes with Roadie

Focus on using Backstage, rather than building and maintaining it.

I want to go faster