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

cicd-statistics-module-gitlab

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

Getting started

• Install the cicd-statistics and cicd-statistics-module-gitlab plugins in the app package.

• Configure your ApiFactory:

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

// packages/app/src/apis.ts
import { gitlabAuthApiRef } from '@backstage/core-plugin-api';

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

export const apis: AnyApiFactory[] = [
  createApiFactory({
    api: cicdStatisticsApiRef,
    deps: { gitlabAuthApi: gitlabAuthApiRef },
    factory({ gitlabAuthApi }) {
      return new CicdStatisticsApiGitlab(gitlabAuthApi);
    },
  }),
];

• 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 cicdStatisticsPluginGitlabModule from '@backstage-community/plugin-cicd-statistics-module-gitlab/alpha';

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

Extensions

The following extensions are available in the plugin:

• api:cicd-statistics/cicd-statistics-gitlab-api