0.4.2 • Published 1 year ago

@backstage/plugin-github-issues v0.4.2

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

GitHub Issues plugin

Welcome to the GitHub Issues plugin!

Based on the well-known GitHub slug annotation associated with the Entity, it renders the list of Open issues in GitHub.

The plugin is designed to work with four Entity kinds, and it behaves a bit differently depending on that kind:

  • Kind: Group/User: plugin renders issues from all repositories for which the Entity is the owner.
  • Kind: API/Component: plugin renders issues from only one repository assigned to the Entity

Issues are sorted from the recently updated DESC order (the plugin might not render all issues from a single repo next to each other).

Prerequisites

Usage

Install the plugin by running the following command from your Backstage root directory

yarn --cwd packages/app add @backstage/plugin-github-issues

After installation, the plugin can be used as a Card or as a Page.

import {
  GitHubIssuesCard,
  GitHubIssuesPage,
} from '@backstage/plugin-github-issues';

// To use as a page Plugin needs to be wrapped in EntityLayout.Route
const RenderGitHubIssuesPage = () => (
  <EntityLayoutWrapper>
    <EntityLayout.Route path="/" title="Overview">
      <EntityLayout.Route path="github-issues" title="GitHub Issues">
        <GitHubIssuesPage />
      </EntityLayout.Route>
    <EntityLayout.Route />
  </EntityLayoutWrapper>
);

// To use as a card and make it render correctly please place it inside appropriate Grid elements
const RenderGitHubIssuesCard = () => (
  <EntityLayoutWrapper>
    <EntityLayout.Route path="/" title="Overview">
      <Grid container spacing={3}>
        <Grid item xs={12}>
          <GitHubIssuesCard />
        </Grid>
      </Grid>
    <EntityLayout.Route />
  </EntityLayoutWrapper>
);

Configuration

Both GitHubIssuesPage and GitHubIssuesCard provide default configuration. It is ready to use out of the box. However, you can configure the plugin with props:

  • itemsPerPage: number = 10 - Issues in the list are paginated, number of issues on a single page is controlled with this prop
  • itemsPerRepo: number = 40 - the plugin doesn't download all Issues available on GitHub. By default, it will get at most 40 Issues - this prop controls this behaviour
0.4.2

1 year ago

0.4.1

1 year ago

0.4.1-next.1

1 year ago

0.4.1-next.0

1 year ago

0.4.0

1 year ago

0.3.0

1 year ago

0.2.20

1 year ago

0.2.20-next.2

1 year ago

0.2.20-next.1

1 year ago

0.2.20-next.0

1 year ago

0.2.19

1 year ago

0.2.19-next.3

1 year ago

0.2.19-next.2

1 year ago

0.2.19-next.1

1 year ago

0.2.19-next.0

1 year ago

0.2.18

1 year ago

0.2.18-next.2

1 year ago

0.2.18-next.1

2 years ago

0.2.18-next.0

2 years ago

0.2.17

2 years ago

0.2.17-next.3

2 years ago

0.2.17-next.2

2 years ago

0.2.17-next.1

2 years ago

0.2.13-next.3

2 years ago

0.2.13-next.2

2 years ago

0.2.13-next.1

2 years ago

0.2.9-next.1

2 years ago

0.2.9-next.2

2 years ago

0.2.17-next.0

2 years ago

0.2.10-next.2

2 years ago

0.2.10-next.1

2 years ago

0.2.10-next.0

2 years ago

0.2.14-next.1

2 years ago

0.2.14-next.2

2 years ago

0.2.14-next.0

2 years ago

0.2.15-next.1

2 years ago

0.2.15-next.0

2 years ago

0.2.15-next.2

2 years ago

0.2.16

2 years ago

0.2.15

2 years ago

0.2.14

2 years ago

0.2.13

2 years ago

0.2.12

2 years ago

0.2.11

2 years ago

0.2.10

2 years ago

0.2.12-next.0

2 years ago

0.2.9

2 years ago

0.2.9-next.0

2 years ago

0.2.8-next.3

2 years ago

0.2.8-next.2

2 years ago

0.2.8

2 years ago

0.2.8-next.1

2 years ago

0.2.8-next.0

2 years ago

0.2.7-next.2

2 years ago

0.2.7-next.1

2 years ago

0.2.7

2 years ago

0.2.7-next.0

2 years ago

0.2.6-next.3

2 years ago

0.2.6

2 years ago

0.2.5-next.0

2 years ago

0.2.5-next.2

2 years ago

0.2.5-next.1

2 years ago

0.2.6-next.0

2 years ago

0.2.6-next.1

2 years ago

0.2.6-next.2

2 years ago

0.2.5

2 years ago

0.2.4

2 years ago

0.2.3-next.2

2 years ago

0.2.3-next.1

3 years ago

0.2.4-next.2

2 years ago

0.2.4-next.0

2 years ago

0.2.4-next.1

2 years ago

0.2.3

2 years ago

0.2.1-next.3

3 years ago

0.2.1-next.4

3 years ago

0.2.1-next.1

3 years ago

0.2.0-next.1

3 years ago

0.2.1-next.2

3 years ago

0.2.0-next.0

3 years ago

0.2.1-next.0

3 years ago

0.2.3-next.0

3 years ago

0.1.2

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.2.2

3 years ago

0.1.2-next.1

3 years ago

0.1.2-next.2

3 years ago

0.1.2-next.0

3 years ago

0.1.1-next.2

3 years ago

0.1.1-next.1

3 years ago

0.1.1-next.0

3 years ago

0.1.1

3 years ago

0.1.0

3 years ago

0.1.0-next.0

3 years ago