@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

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

yarn add @roadiehq/backstage-plugin-buildkite

• Add proxy config:

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

• Import it into your Backstage application:

// packages/app/src/components/catalog/EntityPage.tsx
import {
  EntityBuildkiteContent,
  isPluginApplicableToEntity as 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>
);

Alternatively, the plugin can be configured to only display default branch builds (However, this may be overwritten on a per-entity basis via a buildkite.com/branch or buildkite.com/default-branch-only: false entity annotations, as explained below):

// packages/app/src/components/catalog/EntityPage.tsx
export const cicdContent = (
  <EntitySwitch>
    <EntitySwitch.Case if={isBuildkiteAvailable}>
      <EntityBuildkiteContent defaultBranchOnly />
    </EntitySwitch.Case>
    ...
  </EntitySwitch>
);

How to use Buildkite plugin in Backstage

• Add annotation to the yaml config file of a component:

metadata:
  annotations:
    buildkite.com/project-slug: [exampleorganization/exampleproject]
    # Optional; the buildkite.com/branch annotation can be used to configure
    # the plugin to only display builds of the specified branch name.
    #
    # If omitted, the plugin displays builds from all branches.
    #
    # Note that 'buildkite.com/branch' takes precedence over a
    # globally-configured <EntityBuildkiteContent defaultBranchOnly />.
    buildkite.com/branch: 'main'
    # Optional; the buildkite.com/default-branch-only annotation can be used to
    # configure the plugin to only display builds of the default branch name,
    # the value of which is dynamically determined via the Buildkite API.
    #
    # Note that...
    # A 'buildkite.com/branch' annotation takes precedence over 'buildkite.com/default-branch-only'.
    # A 'buildkite.com/default-branch-only: false' takes precedence over a
    # globally-configured <EntityBuildkiteContent defaultBranchOnly />.
    # "true" and "false" are the only supported values.
    buildkite.com/default-branch-only: 'true'

• Get an api token from buildkite and export it to your shell.

export BUILDKITE_API_TOKEN=xxx-xxx-xxx

Links

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

Roadie gives you a hassle-free, fully customisable SaaS Backstage. Find out more here: https://roadie.io.