Giter Club home page Giter Club logo

backstage-plugin-github-pull-requests's Introduction

GitHub Pull Requests Plugin for Backstage

a list of pull requests in the GitHub Pull Requests

Plugin Setup

  1. If you have standalone app (you didn't clone this repo), then do
yarn add @roadiehq/backstage-plugin-github-pull-requests
  1. Add plugin to the list of plugins:
// packages/app/src/plugins.ts
export { plugin as GithubPullRequests } from '@roadiehq/backstage-plugin-github-pull-requests';
  1. Add plugin API to your Backstage instance:
// packages/app/src/components/catalog/EntityPage.tsx
import { Router as PullRequestsRouter } from '@roadiehq/backstage-plugin-github-pull-requests';

...

const ServiceEntityPage = ({ entity }: { entity: Entity }) => (
  <EntityPageLayout>
    ...
    <EntityPageLayout.Content
          path="/pull-requests"
          title="Pull Requests"
          element={<PullRequestsRouter entity={entity} />}
        />
  </EntityPageLayout>
  1. Run backstage app with yarn start and navigate to services tabs.

Widget setup

a list of pull requests in the GitHub Pull Requests

  1. You must install plugin by following the steps above to add widget to your Overview

  2. Add widget to your Overview tab:

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

...

const OverviewContent = ({ entity }: { entity: Entity }) => (
  <Grid container spacing={3}>
    ...
    <Grid item md={6}>
      <PullRequestsStatsCard entity={entity} />
    </Grid>
  </Grid>
);

Features

  • List Pull Requests for your repository, with filtering and search.
  • Show basic statistics widget about pull requests for your repository.

Links

backstage-plugin-github-pull-requests's People

Contributors

dtuite avatar iain-b avatar lewtakm avatar mcalus3 avatar tomek-ifm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.