Files
backstage/plugins/github-deployments
ImgBotApp a19e461d0a [ImgBot] Optimize images
*Total -- 109.92kb -> 73.66kb (32.99%)

/plugins/github-deployments/docs/github-deployments-card.png -- 103.64kb -> 67.39kb (34.98%)
/microsite/static/img/backstage-service-catalog.svg -- 1.30kb -> 1.30kb (0.3%)
/microsite/static/img/backstage-techdocs.svg -- 0.91kb -> 0.91kb (0.11%)
/microsite/static/img/backstage-k8s.svg -- 1.89kb -> 1.89kb (0.05%)
/microsite/static/img/backstage-software-templates.svg -- 2.17kb -> 2.17kb (0.05%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
2021-03-31 15:36:32 +00:00
..
2021-03-29 14:21:01 +01:00
2021-03-31 15:36:32 +00:00
2021-03-30 18:05:16 +01:00
2021-03-29 14:21:01 +01:00
2021-03-31 15:40:35 +01:00
2021-03-30 17:46:22 +01:00

GitHub Deployments Plugin

The GitHub Deployments Plugin displays recent deployments from GitHub.

github-deployments-card

Prerequisites

Getting Started

  1. Install the GitHub Deployments Plugin.
# packages/app

yarn add @backstage/plugin-github-deployments
  1. Add the plugin to the app
// packages/app/src/plugins.ts

export { githubDeploymentsPlugin as GithubDeploymentsPlugin } from '@backstage/plugin-github-deployments';
  1. 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>
);
  1. 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