The backstage-plugin-github from statusneo

backstage-plugin-github's Introduction

GitHub Homepage Cards for Backstage Enterprise

To know more about the plugin, read this blog.

Setup

Before you can start using the GitHub cards, you must set up a GitHub provider.

You can follow this documentation which will guide you through the process of setting up the GitHub provider for your Backstage instance.

Now in the below steps, I will assume you are already done with the provider.

Integration Steps

First Install the GitHub cards plugin by running this command from the root of the package.

yarn add –cwd packages/app @statusneo/backstage-plugin-github

add this to the app/src/apis.ts

  import { githubApiRef, GithubClient as StatusNeoGithubClient } from '@statusneo/backstage-plugin-github';

  // ...
  createApiFactory({
    api: githubApiRef,
    deps: { authApi: githubAuthApiRef, fetchApi: fetchApiRef, configApi: configApiRef },
    factory(deps) {
      return new StatusNeoGithubClient(deps);
    },
  }),
  // ...

Import GithubPullRequestsCard, and GithubActionsCard from the installed package.
You can then use these components at the backstage frontend wherever you need.

import { GithubPullRequestsCard, GithubActionsCard } from '@statusneo/backstage-plugin-github';

// ...
              <Grid item xs={12} md={6}>
                <GithubActionsCard />
              </Grid>
              <Grid item xs={12} md={6}>
                <GithubPullRequestsCard />
              </Grid>
// ...

If you are using a GitHub enterprise edition, you can pass your instance url through app-config.yml

gh-plugin:
  url: ${GITHUB_ENTERPRISE_URL}

Now you are ready to use this Backstage GitHub plugin to make your software management and development cycle a little more hassle-free.

backstage-plugin-github's People

Contributors

Stargazers

backstage-plugin-github's Issues

Plugin fails to run with @roadiehq/backstage-plugin-github-insights because they register api with the same name

Unable to Authenticate with GitHub Using Outlook Authentication

I encountered an issue while attempting to authenticate with GitHub using Outlook authentication. Upon attempting to sign in, I received the following error:

GET http://localhost:7007/api/auth/github/refresh?optional&scope=read%3Auser&env=development 401 (Unauthorized)

does the plugin work with backstage 1.13.0?

Hello @NishkarshRaj ,

We tried installing the plugin and including it in the HomePage.tsx (we already use the Github provider beforehand)
the widgets appear in the home page but they're empty and upon pressing login in them nothing happens and no error is thrown in the browser.

Also tried to add them in the GroupEntityPage but this seems conflict with Spotify's Shortcut plugin and crashes immediately.

Any hints what might be wrong?

Thanks