diff --git a/.changeset/migrate-1713466197726.md b/.changeset/migrate-1713466197726.md new file mode 100644 index 0000000000..ab70d3e27c --- /dev/null +++ b/.changeset/migrate-1713466197726.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-sentry': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/sentry/README.md b/plugins/sentry/README.md index 78f31952b2..2443369cae 100644 --- a/plugins/sentry/README.md +++ b/plugins/sentry/README.md @@ -1,103 +1,3 @@ -# Sentry Plugin +# Deprecated -The Sentry Plugin displays issues from [Sentry](https://sentry.io). - -![Sentry Card](./docs/sentry-card.png) - -## Getting Started - -1. Install the Sentry Plugin: - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-sentry -``` - -2. Add the `EntitySentryCard` to the EntityPage: - -```jsx -// packages/app/src/components/catalog/EntityPage.tsx - -import { EntitySentryCard } from '@backstage/plugin-sentry'; - -const overviewContent = ( - - // ... - - - - // ... - -); -``` - -> You can also import the full-page `EntitySentryContent` extension if you want to have a dedicated sentry page: -> -> ```tsx -> // packages/app/src/components/catalog/EntityPage.tsx -> -> import { EntitySentryContent } from '@backstage/plugin-sentry'; -> -> const serviceEntityPage = ( -> -> // ... -> -> -> -> // ... -> -> ); -> ``` - -3. Add the proxy config: - -```yaml -# app-config.yaml - -proxy: - '/sentry/api': - target: https://sentry.io/api/ - allowedMethods: ['GET'] - headers: - Authorization: Bearer ${SENTRY_TOKEN} - -sentry: - organization: -``` - -4. Create a new internal integration with the permissions `Issues & Events: Read` (https://docs.sentry.io/product/integrations/integration-platform/) and provide it as `SENTRY_TOKEN` as env variable. - -5. Add the `sentry.io/project-slug` annotation to your catalog-info.yaml file: - -```yaml -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: backstage - description: | - Backstage is an open-source developer portal that puts the developer experience first. - annotations: - sentry.io/project-slug: YOUR_PROJECT_SLUG -spec: - type: library - owner: CNCF - lifecycle: experimental -``` - -### Demo Mode - -The plugin provides a MockAPI that always returns dummy data instead of talking to the sentry backend. -You can add it by overriding the `sentryApiRef`: - -```ts -// packages/app/src/apis.ts - -import { createApiFactory } from '@backstage/core-plugin-api'; -import { MockSentryApi, sentryApiRef } from '@backstage/plugin-sentry'; - -export const apis = [ - // ... - - createApiFactory(sentryApiRef, new MockSentryApi()), -]; -``` +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-sentry` instead. diff --git a/plugins/sentry/package.json b/plugins/sentry/package.json index 77ad095c19..b511a49b17 100644 --- a/plugins/sentry/package.json +++ b/plugins/sentry/package.json @@ -3,7 +3,8 @@ "version": "0.5.19", "description": "A Backstage plugin that integrates towards Sentry", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-sentry" }, "publishConfig": { "access": "public", @@ -64,5 +65,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-sentry instead." }