@roadiehq/backstage-plugin-buildkite

Buildkite CI/CD Plugin for Backstage

Features

• List Buildkite CI/CD Builds
• Retrigger builds
• Inspect each builds step in real time

How to add Buildkite project dependency to Backstage app

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

yarn add @roadiehq/backstage-plugin-buildkite

1. Add proxy config:

// app-config.yaml
proxy:
  '/buildkite/api':
    target: https://api.buildkite.com/v2/
    headers:
      Authorization: 
        $env: BUILDKITE_TOKEN

1. Add plugin to the list of plugins:

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

1. 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 }) => {
  // This component is just an example of how you can implement your company's logic in entity page.
  // You can for example enforce that all components of type 'service' should use GitHubActions
  switch (true) {
    case isBuildkiteAvailable(entity):
      return <BuildkiteRouter entity={entity} />;
  ...
  }
};

How to use Buildkite plugin in Backstage

1. Add annotation to the yaml config file of a component:

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

1. Get and provide BUILDKITE_TOKEN as env variable.

Links

• Backstage
• Further instructons
• Get hosted, managed Backstage for your company: https://roadie.io