From 077c7bf35eebce1e8f80e427dc599249f386f1c1 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:45:52 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713465949447.md | 5 ++ plugins/codescene/README.md | 102 +--------------------------- plugins/codescene/package.json | 6 +- 3 files changed, 11 insertions(+), 102 deletions(-) create mode 100644 .changeset/migrate-1713465949447.md diff --git a/.changeset/migrate-1713465949447.md b/.changeset/migrate-1713465949447.md new file mode 100644 index 0000000000..577faf7f65 --- /dev/null +++ b/.changeset/migrate-1713465949447.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-codescene': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/codescene/README.md b/plugins/codescene/README.md index 6770e34ddd..693c977d22 100644 --- a/plugins/codescene/README.md +++ b/plugins/codescene/README.md @@ -1,101 +1,3 @@ -# codescene +# Deprecated -[CodeScene](https://codescene.com/) is a multi-purpose tool that connects code, businesses, and people. Discover hidden hazards and social trends in your code. Prioritise and minimise technical debt. - -The CodeScene Backstage Plugin provides a page component that displays a list of existing projects and associated analysis data on your CodeScene instance. - -![screenshot](./docs/codescene-plugin-screenshot.png) - -## Setup - -1. Install the plugin by running: - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-codescene -``` - -2. Add the routes and pages to your `App.tsx`: - -```tsx -import { - CodeScenePage, - CodeSceneProjectDetailsPage, -} from '@backstage/plugin-codescene'; - -... - -} /> -} -/> -``` - -3. Add to the sidebar item routing to the new page: - -```tsx -// In packages/app/src/components/Root/Root.tsx -import { CodeSceneIcon } from '@backstage/plugin-codescene'; - -{ - /* other sidebar items... */ -} -; -``` - -4. Setup the `app-config.yaml` `codescene` proxy and configuration blocks: - -```yaml -proxy: - '/codescene-api': - target: '/api/v1' - allowedMethods: ['GET'] - allowedHeaders: ['Authorization'] - headers: - Authorization: Basic ${CODESCENE_AUTH_CREDENTIALS} -``` - -```yaml -codescene: - baseUrl: https://codescene.my-company.net # replace with your own URL -``` - -5. Adding the codescene plugin to Entity page: - -```yaml -# Add `codescene` annotations to the `catalog-info.yaml` of an entity. -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: backstage - annotations: - codescene.io/project-id: -``` - -```tsx -// In packages/app/src/components/catalog/EntityPage.tsx - -import { - CodeSceneEntityPage, - CodeSceneEntityFileSummary, - isCodeSceneAvailable, -} from '@backstage/plugin-codescene'; - -/* other EntityLayout.Route items... */ - - - - - - - - - - -; -``` +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-codescene` instead. diff --git a/plugins/codescene/package.json b/plugins/codescene/package.json index 3a17b700e3..f329c641b7 100644 --- a/plugins/codescene/package.json +++ b/plugins/codescene/package.json @@ -2,7 +2,8 @@ "name": "@backstage/plugin-codescene", "version": "0.1.26", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-codescene" }, "publishConfig": { "access": "public", @@ -62,5 +63,6 @@ "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-router-dom": "6.0.0-beta.0 || ^6.3.0" }, - "configSchema": "config.d.ts" + "configSchema": "config.d.ts", + "deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-codescene instead." }