From b935e60d64f49250c1e0f5dee5f3326c73ed5ffc Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:47:27 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713466045590.md | 5 ++ plugins/github-issues/README.md | 81 +---------------------------- plugins/github-issues/package.json | 6 ++- 3 files changed, 11 insertions(+), 81 deletions(-) create mode 100644 .changeset/migrate-1713466045590.md diff --git a/.changeset/migrate-1713466045590.md b/.changeset/migrate-1713466045590.md new file mode 100644 index 0000000000..b12d7e4617 --- /dev/null +++ b/.changeset/migrate-1713466045590.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-github-issues': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/github-issues/README.md b/plugins/github-issues/README.md index f6b383bfcc..e8b028cff8 100644 --- a/plugins/github-issues/README.md +++ b/plugins/github-issues/README.md @@ -1,80 +1,3 @@ -# GitHub Issues plugin +# Deprecated -Welcome to the GitHub Issues plugin! - -Based on the [well-known GitHub slug annotation](https://backstage.io/docs/features/software-catalog/well-known-annotations#githubcomproject-slug) 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 - -- [GitHub Authentication Provider](https://backstage.io/docs/auth/github/provider) - -## 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. - -```typescript -import { - GithubIssuesCard, - GithubIssuesPage, -} from '@backstage/plugin-github-issues'; - -// To use as a page Plugin needs to be wrapped in EntityLayout.Route -const RenderGitHubIssuesPage = () => ( - - - - - - - -); - -// To use as a card and make it render correctly please place it inside appropriate Grid elements -const RenderGitHubIssuesCard = () => ( - - - - - - - - - -); -``` - -## 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 -- `filterBy: object` - the plugin can be configured to filter the query by `assignee`, `createdBy`, `labels`, `states`, `mentioned` or `milestone`. -- `orderBy: object = { field: 'UPDATED_AT', direction: 'DESC' }` - The ordering that the issues are returned can be configured by the `orderBy` field. - -### `filterBy` and `orderBy` example - -```ts - -``` +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-github-issues` instead. diff --git a/plugins/github-issues/package.json b/plugins/github-issues/package.json index 779392da03..2a82817dc7 100644 --- a/plugins/github-issues/package.json +++ b/plugins/github-issues/package.json @@ -2,7 +2,8 @@ "name": "@backstage/plugin-github-issues", "version": "0.4.1", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-github-issues" }, "publishConfig": { "access": "public", @@ -58,5 +59,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-issues instead." }