https://github.com/statusneo/backstage-plugin-github
A plugin to showcase Recent Pull Requests and Actions pipeline relevant to the user at the homepage in Backstage Enterprise.
https://github.com/statusneo/backstage-plugin-github
backstage devex github
Last synced: 5 months ago
JSON representation
A plugin to showcase Recent Pull Requests and Actions pipeline relevant to the user at the homepage in Backstage Enterprise.
- Host: GitHub
- URL: https://github.com/statusneo/backstage-plugin-github
- Owner: StatusNeo
- License: apache-2.0
- Created: 2023-03-15T08:55:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-13T13:53:37.000Z (about 2 years ago)
- Last Synced: 2025-08-07T09:49:15.234Z (6 months ago)
- Topics: backstage, devex, github
- Language: TypeScript
- Homepage: https://www.statusneo.com/rearportal
- Size: 2.03 MB
- Stars: 21
- Watchers: 0
- Forks: 8
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## GitHub Homepage Cards for Backstage Enterprise
To know more about the plugin, read this [blog](https://statusneo.com/23468-2).
### Setup
Before you can start using the GitHub cards, you must set up a GitHub provider.
You can follow this [documentation](https://backstage.io/docs/auth/github/provider/) 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
1. First Install the GitHub cards plugin by running this command from the root of the package.
```shell
yarn add –cwd packages/app @statusneo/backstage-plugin-github
```
2. add this to the app/src/apis.ts
```javascript
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);
},
}),
// ...
```
3. Import `GithubPullRequestsCard`, and `GithubActionsCard` from the installed package.
4. You can then use these components at the backstage frontend wherever you need.
```javascript
import { GithubPullRequestsCard, GithubActionsCard } from '@statusneo/backstage-plugin-github';
// ...
// ...
```
5. If you are using a GitHub enterprise edition, you can pass your instance url through app-config.yml
```yaml
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.