Files
backstage/plugins/github-deployments
dependabot[bot] 24254fd433 build(deps): bump @testing-library/user-event from 13.5.0 to 14.0.0
Bumps [@testing-library/user-event](https://github.com/testing-library/user-event) from 13.5.0 to 14.0.0.
- [Release notes](https://github.com/testing-library/user-event/releases)
- [Changelog](https://github.com/testing-library/user-event/blob/main/CHANGELOG.md)
- [Commits](https://github.com/testing-library/user-event/compare/v13.5.0...v14.0.0)

---
updated-dependencies:
- dependency-name: "@testing-library/user-event"
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-04-05 10:19:52 +02:00
..
2022-03-04 11:17:24 +01:00
2022-03-29 08:42:22 +00: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.
# From your Backstage root directory
yarn add --cwd packages/app @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

Self-hosted / Enterprise GitHub

The plugin will try to use backstage.io/source-location or backstage.io/managed-by-location annotations to figure out the location of the source code.

  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'