Backstage Buildkite Plugin

See Buildkite Builds in Backstage

Getting started is simple

Install the plugin

yarn add @roadiehq/backstage-plugin-buildkite

Import it into your Backstage application

// packages/app/src/plugins.ts
export { plugin as Buildkite } from '@roadiehq/backstage-plugin-buildkite';

Add proxy configuration'

// app-config.yaml
proxy:

...

'/buildkite/api':
  target: https://api.buildkite.com/v2/
  headers:
    Authorization: 
      $env: BUILDKITE_TOKEN

Add plugin API to your Backstage instance.

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

const CICDSwitcher = ({ entity }: { entity: Entity }) => {
  switch (true) {
    ...
    case isBuildkiteAvailable(entity):
      return ;
    ...
  }
}

Add annotation to your component-info.yaml file.

metadata:
  annotations:
    buildkite.com/project-slug: [exampleorganization/exampleproject]

How it looks

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.