From a5613e38beff4aff680ad625d7cb2a474979c1ff Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:50:59 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713466257285.md | 5 ++++ plugins/xcmetrics/README.md | 38 ++--------------------------- plugins/xcmetrics/package.json | 6 +++-- 3 files changed, 11 insertions(+), 38 deletions(-) create mode 100644 .changeset/migrate-1713466257285.md diff --git a/.changeset/migrate-1713466257285.md b/.changeset/migrate-1713466257285.md new file mode 100644 index 0000000000..a7e9b68136 --- /dev/null +++ b/.changeset/migrate-1713466257285.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-xcmetrics': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/xcmetrics/README.md b/plugins/xcmetrics/README.md index 0823cbbb24..2fb0f202ae 100644 --- a/plugins/xcmetrics/README.md +++ b/plugins/xcmetrics/README.md @@ -1,37 +1,3 @@ -# XCMetrics +# Deprecated -[XCMetrics](https://xcmetrics.io) is a tool for collecting build metrics from XCode. -With this plugin, you can view data from XCMetrics directly in Backstage. - -![XCMetrics-overview](./docs/XCMetrics-overview.png) - -## Getting started - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-xcmetrics -``` - -In `packages/app/src/App.tsx`, add the following: - -```ts -import { XcmetricsPage } from '@backstage/plugin-xcmetrics'; -``` - -```tsx - - {/* Other routes... */} - } /> - -``` - -Add the URL to your XCMetrics backend instance in `app-config.yaml` like so: - -```yaml -proxy: - ... - '/xcmetrics': - target: http://127.0.0.1:8080/v1 -``` - -Start Backstage and navigate to `/xcmetrics` to view your build metrics! +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-xcmetrics` instead. diff --git a/plugins/xcmetrics/package.json b/plugins/xcmetrics/package.json index 2ba48c6fcb..768abe6ac9 100644 --- a/plugins/xcmetrics/package.json +++ b/plugins/xcmetrics/package.json @@ -3,7 +3,8 @@ "version": "0.2.52", "description": "A Backstage plugin that shows XCode build metrics for your components", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-xcmetrics" }, "publishConfig": { "access": "public", @@ -59,5 +60,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-xcmetrics instead." }