Backstage Buildkite Plugin

See Buildkite Builds in Backstage

Created by Roadie

Getting started is simple

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

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: 
        $env: 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: [exampleorganization/exampleproject]

Get and provide BUILDKITE_TOKEN as env variable. Note that the token needs to be in format Bearer TOKEN

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.

Things to know

Features

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

single build view in buildkite plugin

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.