Backstage GitHub Pull Requests Plugin

See Pull Requests for your service in Backstage

Getting started is simple

Install the plugin into Backstage.

// packages/app
'yarn add @roadiehq/backstage-plugin-github-pull-requests'

Add plugin API to your Backstage instance.

// packages/app/src/components/catalog/EntityPage.tsx
import { EntityGithubPullRequestsContent } from '@roadiehq/backstage-plugin-github-pull-requests';

// ...

const serviceEntityPage = (
  <EntityLayout>
    ...
    <EntityLayout.Route path="/pull-requests" title="Pull Requests">
      <EntityGithubPullRequestsContent />
    </EntityLayout.Route>
    ...
  </EntityLayout>
)

Run the backstage app with the following command and navigate to the services tab.

yarn start

Add widget to your Overview tab.

// packages/app/src/components/catalog/EntityPage.tsx
import { EntityGithubPullRequestsOverviewCard } from '@roadiehq/backstage-plugin-github-pull-requests';

  // ...
  const overviewContent = (
    <Grid container spacing={3}>
      ...
      <Grid item md={6}>
        <EntityGithubPullRequestsOverviewCard />
      </Grid>
      ...
    </Grid>
  );

Found a mistake? Update these instructions.

How it looks

Pull requests for Backstage rendered inside a Backstage plugin.
The statistics widget is alongside, showing the average time to merge a PR.

Things to know

Repository migration notice (June/July 2021)

In order to make testing and deployment of our plugins easier we are migrating all Roadie plugins to a monorepo at https://github.com/RoadieHQ/backstage-roadie-plugins.

The plugins will still be published to the same place on NPM and will have the same package names so nothing should change for consumers of these plugins.

Plugin Configuration Requirements

This plugin relies on the GitHub Authentication Provider for its access to GitHub.

Become a Backstage expert

To get the latest news, deep dives into Backstage features, and a roundup of recent open-source action, sign up for Roadie's Backstage Weekly. See recent editions.

We will never sell or share your email address.