paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 40 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:46:20 +02:00
parent fd9024c9d5
commit 3242f69c8e
3 changed files with 11 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/entity-validation/README.md
+2 -53
View File
@@ -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 = (
<FlatRoutes>
{/* ...other routes */}
<Route path="/entity-validation" element={<EntityValidationPage />} />
</FlatRoutes>
);
```
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<{}>) => (
<SidebarPage>
<Sidebar>
{/* ...other elements */}
<SidebarGroup label="Menu" icon={<MenuIcon />}>
{/* Global nav, not org-specific */}
{/* ...other sidebars */}
<SidebarItem icon={BuildIcon} to="entity-validation" text="Validator" />
{/* End global nav */}
<SidebarDivider />
</SidebarGroup>
{/* ...other elements */}
</Sidebar>
{children}
</SidebarPage>
);
```
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.
plugins/entity-validation/package.json
+4 -2
View File
@@ -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."
}