backstage/plugins/github-deployments/README.md

GitHub Deployments Plugin

The GitHub Deployments Plugin displays recent deployments from GitHub.

Prerequisites

• GitHub Authentication Provider

Getting Started

1. Install the GitHub Deployments Plugin.

# packages/app

yarn add @backstage/plugin-github-deployments

2. Add the plugin to the app

// packages/app/src/plugins.ts

export { githubDeploymentsPlugin as GithubDeploymentsPlugin } from '@backstage/plugin-github-deployments';

3. Add the EntityGithubDeploymentsCard to the EntityPage:

// packages/app/src/components/catalog/EntityPage.tsx

import { EntityGithubDeploymentsCard } from '@backstage/plugin-github-deployments';

const OverviewContent = () => (
  <Grid container spacing={3} alignItems="stretch">
    // ...
    <Grid item xs={12} sm={6} md={4}>
      <EntityGithubDeploymentsCard />
    </Grid>
    // ...
  </Grid>
);

4. Add the github.com/project-slug annotation to your catalog-info.yaml file:

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: backstage
  description: |
    Backstage is an open-source developer portal that puts the developer experience first.
  annotations:
    github.com/project-slug: YOUR_PROJECT_SLUG
spec:
  type: library
  owner: CNCF
  lifecycle: experimental

Self-hosted / Enterprise GitHub

1. Add the host and apiBaseUrl to your app-config.yaml

# app-config.yaml

integrations:
  github:
    - host: 'your-github-host.com'
      apiBaseUrl: 'https://api.your-github-host.com'

2. Pass the host into the EntityGithubDeploymentsCard

// packages/app/src/components/catalog/EntityPage.tsx

import { EntityGithubDeploymentsCard } from '@backstage/plugin-github-deployments';

const OverviewContent = () => (
  <Grid container spacing={3} alignItems="stretch">
    // ...
    <Grid item xs={12} sm={6} md={4}>
      <EntityGithubDeploymentsCard host='your-github-host.com' />
    </Grid>
    // ...
  </Grid>
);