From 3242f69c8e66a33cfaf0fa57c62c003520db06c7 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:46:20 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713465978303.md | 5 +++ plugins/entity-validation/README.md | 55 +------------------------- plugins/entity-validation/package.json | 6 ++- 3 files changed, 11 insertions(+), 55 deletions(-) create mode 100644 .changeset/migrate-1713465978303.md diff --git a/.changeset/migrate-1713465978303.md b/.changeset/migrate-1713465978303.md new file mode 100644 index 0000000000..2e3bde1cae --- /dev/null +++ b/.changeset/migrate-1713465978303.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-entity-validation': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/entity-validation/README.md b/plugins/entity-validation/README.md index f831007a45..20b58cb98f 100644 --- a/plugins/entity-validation/README.md +++ b/plugins/entity-validation/README.md @@ -1,54 +1,3 @@ -# entity-validation +# Deprecated -This plugin creates a new page in Backstage where the user can validate the entities. - -![Entity Validation](./docs/entity-validation.png) - -## Getting started - -First of all, install the package in the `app` package by running the following command: - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-entity-validation -``` - -Add the new route to the app by adding the following line: - -```typescript -// In packages/app/src/App.tsx -import { EntityValidationPage } from '@backstage/plugin-entity-validation'; - -const routes = ( - - {/* ...other routes */} - } /> - -); -``` - -To add the new page to your sidebar, you must include these lines in your `Root.tsx` file: - -```typescript - // In packages/app/src/components/Root/Root.tsx - import BuildIcon from '@material-ui/icons/Build'; - - ... - - export const Root = ({ children }: PropsWithChildren<{}>) => ( - - - {/* ...other elements */} - }> - {/* Global nav, not org-specific */} - {/* ...other sidebars */} - - {/* End global nav */} - - - {/* ...other elements */} - - {children} - - ); -``` +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-entity-validation` instead. diff --git a/plugins/entity-validation/package.json b/plugins/entity-validation/package.json index 5821a3cd7a..e44033b18c 100644 --- a/plugins/entity-validation/package.json +++ b/plugins/entity-validation/package.json @@ -2,7 +2,8 @@ "name": "@backstage/plugin-entity-validation", "version": "0.1.19", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-entity-validation" }, "publishConfig": { "access": "public", @@ -64,5 +65,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-entity-validation instead." }