Backstage GitLab Plugin

# from your Backstage root
yarn --cwd packages/app add @immobiliarelabs/backstage-plugin-gitlab
yarn --cwd packages/backend add @immobiliarelabs/backstage-plugin-gitlab-backend

# app-config.yaml
integrations:
  gitlab:
    - host: gitlab.com
      token: ${GITLAB_TOKEN}
    # you can add more instances by adding more items
    # - host: gitlab.mycompany.internal
    #   token: ${GITLAB_INTERNAL_TOKEN}

// packages/backend/src/index.ts
import { createBackend } from '@backstage/backend-defaults';
import {
  gitlabPlugin,
  catalogPluginGitlabFillerProcessorModule,
} from '@immobiliarelabs/backstage-plugin-gitlab-backend';

async function start() {
  const backend = createBackend();

  backend.add(gitlabPlugin);
  backend.add(catalogPluginGitlabFillerProcessorModule);

  await backend.start();
}

start().catch(err => {
  process.stderr.write(`${err}\n`);
  process.exit(1);
});

// packages/backend/src/plugins/catalog.ts
import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
import { PluginEnvironment } from '../types';
import { Router } from 'express-serve-static-core';
import { GitlabFillerProcessor } from '@immobiliarelabs/backstage-plugin-gitlab-backend';

export default async function createPlugin(env: PluginEnvironment): Promise<Router> {
  const builder = await CatalogBuilder.create(env);

  // add the filler that enriches entities with GitLab annotations
  builder.addProcessor(new GitlabFillerProcessor(env.config));

  const { processingEngine, router } = await builder.build();
  await processingEngine.start();
  return router;
}

// packages/backend/src/plugins/gitlab.ts
import { PluginEnvironment } from '../types';
import { Router } from 'express-serve-static-core';
import { createRouter } from '@immobiliarelabs/backstage-plugin-gitlab-backend';

export default async function createPlugin(env: PluginEnvironment): Promise<Router> {
  return createRouter({
    logger: env.logger,
    config: env.config,
  });
}

// packages/backend/src/index.ts
import gitlab from './plugins/gitlab';
import { createEnv, useHotMemoize } from './lib'; // or your local helpers

async function main() {
  // other setup

  const gitlabEnv = useHotMemoize(module, () => createEnv('gitlab'));
  apiRouter.use('/gitlab', await gitlab(gitlabEnv));

  // other setup
}

// packages/app/src/components/catalog/EntityPage.tsx
import React from 'react';
import { EntityLayout, EntitySwitch } from '@backstage/plugin-catalog';
import { Grid } from '@backstage/core-components';

import {
  isGitlabAvailable,
  EntityGitlabContent,
  EntityGitlabLanguageCard,
  EntityGitlabMergeRequestsTable,
  EntityGitlabMergeRequestStatsCard,
  EntityGitlabPeopleCard,
  EntityGitlabPipelinesTable,
  EntityGitlabReadmeCard,
  EntityGitlabReleasesCard,
} from '@immobiliarelabs/backstage-plugin-gitlab';

// add a GitLab tab on the service page
export const serviceEntityPage = (
  <EntityLayout>
    <EntityLayout.Route if={isGitlabAvailable} path="/gitlab" title="GitLab">
      <EntityGitlabContent />
    </EntityLayout.Route>
  </EntityLayout>
);

// add cards on the overview page
export const overviewContent = (
  <Grid container spacing={3} alignItems="stretch">
    <EntitySwitch>
      <EntitySwitch.Case if={isGitlabAvailable}>
        <Grid item md={12}>
          <EntityGitlabReadmeCard />
        </Grid>
        <Grid item sm={12} md={3} lg={3}>
          <EntityGitlabPeopleCard />
        </Grid>
        <Grid item sm={12} md={3} lg={3}>
          <EntityGitlabLanguageCard />
        </Grid>
        <Grid item sm={12} md={3} lg={3}>
          <EntityGitlabMergeRequestStatsCard />
        </Grid>
        <Grid item sm={12} md={3} lg={3}>
          <EntityGitlabReleasesCard />
        </Grid>
        <Grid item md={12}>
          <EntityGitlabPipelinesTable />
        </Grid>
        <Grid item md={12}>
          <EntityGitlabMergeRequestsTable />
        </Grid>
      </EntitySwitch.Case>
    </EntitySwitch>
  </Grid>
);

# from your Backstage root if not already installed
yarn --cwd packages/app add @immobiliarelabs/backstage-plugin-gitlab

// packages/app/src/App.tsx
import { createApp } from '@backstage/frontend-app-api';
import catalogPlugin from '@backstage/plugin-catalog/alpha';
import userSettingsPlugin from '@backstage/plugin-user-settings/alpha';
import gitlabPlugin from '@immobiliarelabs/backstage-plugin-gitlab/alpha';

export const app = createApp({
  features: [
    catalogPlugin,
    userSettingsPlugin,
    gitlabPlugin,
  ],
});

# app-config.yaml
app:
  extensions:
    - entity-card:gitlab/people
    - entity-card:gitlab/languages
    - entity-card:gitlab/merge-requests-stats
    - entity-card:gitlab/releases
    - entity-card:gitlab/coverage
    - entity-card:gitlab/readme

# catalog-info.yaml
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: my-service
  annotations:
    gitlab.com/project-id: '1234'            # wrap numeric ids in quotes
    # or use a slug
    gitlab.com/project-slug: 'group_name/project_name'
    # or pin a non default GitLab instance
    gitlab.com/instance: gitlab.internal.abcd
spec:
  type: service
  lifecycle: production
  owner: team-a