paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 26 Packages Projects Releases Wiki Activity

Deprecate packages

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-04-18 20:47:34 +02:00
parent b935e60d64
commit 5dc77e3bd4
3 changed files with 11 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/migrate-1713466052584.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-github-pull-requests-board': patch
---
These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository.
plugins/github-pull-requests-board/README.md
+2 -78
View File
@@ -1,79 +1,3 @@
# GitHub Pull Requests Board Plugin
# Deprecated
The GitHub Pull Requests Board Plugin helps to visualise all **Open Pull Requests** related to the owned team repository.
![github-pull-requests-board](./docs/pull-requests-board.png)
It will help you and your team stay on top of open pull requests, hopefully reducing the time from open to merged. It's particularly useful when your team deals with many repositories.
## Prerequisites
- [GitHub Authentication Provider](https://backstage.io/docs/auth/github/provider) (With `read-only` permission granted for `Pull Requests`)
## Getting started
Install the plugin by running the following command **from your Backstage root directory**
`yarn --cwd packages/app add @backstage/plugin-github-pull-requests-board`
The plugin exports the **EntityTeamPullRequestsCard** component which can be added to the Overview page of the team at `backstage/packages/app/src/components/catalog/EntityPage.tsx`
```javascript
import { EntityTeamPullRequestsCard } from '@backstage/plugin-github-pull-requests-board';
const groupPage = (
<EntityLayoutWrapper>
<EntityLayout.Route path="/" title="Overview">
<Grid container spacing={3}>
{entityWarningContent}
<Grid item xs={12} md={6}>
<EntityGroupProfileCard variant="gridItem" />
</Grid>
<Grid item xs={12} md={6}>
<EntityOwnershipCard
variant="gridItem"
entityFilterKind={customEntityFilterKind}
/>
</Grid>
<Grid item xs={12}>
<EntityMembersListCard />
</Grid>
<Grid item xs={12}>
<EntityTeamPullRequestsCard />
</Grid>
</Grid>
</EntityLayout.Route>
</EntityLayoutWrapper>
);
```
Or you can also import the **EntityTeamPullRequestsContent** component which can be used to add a new tab under the group page at `backstage/packages/app/src/components/catalog/EntityPage.tsx`
```javascript
import { EntityTeamPullRequestsContent } from '@backstage/plugin-github-pull-requests-board';
const groupPage = (
<EntityLayoutWrapper>
<EntityLayout.Route path="/" title="Overview">
<Grid container spacing={3}>
{entityWarningContent}
<Grid item xs={12} md={6}>
<EntityGroupProfileCard variant="gridItem" />
</Grid>
<Grid item xs={12} md={6}>
<EntityOwnershipCard
variant="gridItem"
entityFilterKind={customEntityFilterKind}
/>
</Grid>
<Grid item xs={12}>
<EntityMembersListCard />
</Grid>
</Grid>
</EntityLayout.Route>
<EntityLayout.Route path="/pull-requests" title="Pull Requests">
<EntityTeamPullRequestsContent />
</EntityLayout.Route>
</EntityLayoutWrapper>;
)
```
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-github-pull-requests-board` instead.
plugins/github-pull-requests-board/package.json
+4 -2
View File
@@ -3,7 +3,8 @@
"version": "0.2.0",
"description": "A Backstage plugin that allows you to see all open Pull Requests for all the repositories owned by your team",
"backstage": {
"role": "frontend-plugin"
"role": "frontend-plugin",
"moved": "@backstage-community/plugin-github-pull-requests-board"
},
"publishConfig": {
"access": "public",
@@ -62,5 +63,6 @@
"react": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
}
},
"deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-github-pull-requests-board instead."
}