cicd-statistics-module-github

This is an extension module to the cicd-statistics plugin, providing a CicdStatisticsApiGithub that you can use to extract the CI/CD statistics from your Github repository.

Getting started

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

2. Configure your ApiFactory:

   • You can optionally pass in a third argument to CicdStatisticsApiGithub of type CicdDefaults to alter the default CICD UI configuration

// packages/app/src/apis.ts
import { configApiRef } from '@backstage/core-plugin-api';
import { scmAuthApiRef } from '@backstage/integration-react';

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

export const apis: AnyApiFactory[] = [
  createApiFactory({
    api: cicdStatisticsApiRef,
    deps: {
      scmAuthApi: scmAuthApiRef,
      configApi: configApiRef,
    },
    factory: ({ scmAuthApi, configApi }) => {
      return new CicdStatisticsApiGithub({ scmAuthApi, configApi });
    },
  }),
];

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="/ci-cd-statistics" title="CI/CD Statistics">
  <EntityCicdStatisticsContent />
</EntityLayout.Route>;

New Frontend System

Setup

If you're using feature discovery, the plugin should be automatically discovered and enabled. Otherwise, you can manually enable the plugin by adding it to your app:

// packages/app/src/App.tsx
import cicdStatisticsPluginGithubModule from '@backstage-community/plugin-cicd-statistics-module-github/alpha';

const app = createApp({
  features: [
    // ...
    cicdStatisticsPluginGithubModule,
  ],
});

Extensions

The following extensions are available in the plugin:

• api:cicd-statistics/cicd-statistics-github-api