@backstage-community/plugin-cicd-statistics-module-buildkite

cicd-statistics-module-buildkite

This is an extension module to the cicd-statistics plugin providing a CicdStatisticsApiBuildkite for use extracting CI/CD statistics from Buildkite pipelines.

Getting started

1. Install the cicd-statistics and cicd-statistics-module-buildkite plugins in the app package.

2. Configure your ApiFactory (Note that CicdStatisticsApiBuildkite accepts a CicdStatisticsApiBuildkiteOpts):

// packages/app/src/apis.ts
import {
  createApiFactory,
  discoveryApiRef,
  fetchApiRef,
} from '@backstage/core-plugin-api';

import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';
import { CicdStatisticsApiBuildkite } from '@backstage-community/plugin-cicd-statistics-module-buildkite';

export const apis: AnyApiFactory[] = [
  createApiFactory({
    api: cicdStatisticsApiRef,
    deps: {
      discoveryApi: discoveryApiRef,
      fetchApiApi: fetchApiRef,
    },
    factory({ discoveryApi, fetchApi }) {
      return new CicdStatisticsApiBuildkite({ discoveryApi, fetchApi });
    },
  }),
];

3. Add the component to your EntityPage:

// packages/app/src/components/catalog/EntityPage.tsx
import { EntityCicdStatisticsContent } from '@backstage-community/plugin-cicd-statistics';

<EntityLayout.Route path="/cicd-statistics" title="CI/CD Statistics">
  <EntityCicdStatisticsContent />
</EntityLayout.Route>;

4. Configure entities to feature a buildkite.com/pipeline-name annotation:

annotations:
  buildkite.com/pipeline: 'org-name/some-pipeline'