diff --git a/.changeset/migrate-1713466190774.md b/.changeset/migrate-1713466190774.md new file mode 100644 index 0000000000..4f95905cf2 --- /dev/null +++ b/.changeset/migrate-1713466190774.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-rollbar': patch +'@backstage/plugin-rollbar-backend': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/rollbar-backend/README.md b/plugins/rollbar-backend/README.md index 1f5977f5df..22414c3a9d 100644 --- a/plugins/rollbar-backend/README.md +++ b/plugins/rollbar-backend/README.md @@ -1,72 +1,3 @@ -# Rollbar Backend +# Deprecated -Simple plugin that proxies requests to the [Rollbar](https://rollbar.com) API. - -## Setup - -1. Install the plugin using: - -```bash -# From your Backstage root directory -yarn --cwd packages/backend add @backstage/plugin-rollbar-backend -``` - -2. Create a `rollbar.ts` file inside `packages/backend/src/plugins/`: - -```typescript -import { createRouter } from '@backstage/plugin-rollbar-backend'; -import { Router } from 'express'; -import { PluginEnvironment } from '../types'; - -export default async function createPlugin( - env: PluginEnvironment, -): Promise { - return await createRouter({ - logger: env.logger, - config: env.config, - }); -} -``` - -3. Modify your `packages/backend/src/index.ts` to include: - -```diff - ... - - import { Config } from '@backstage/config'; - import app from './plugins/app'; -+import rollbar from './plugins/rollbar'; - import scaffolder from './plugins/scaffolder'; - - ... - - async function main() { - - ... - - const authEnv = useHotMemoize(module, () => createEnv('auth')); -+ const rollbarEnv = useHotMemoize(module, () => createEnv('rollbar')); - const proxyEnv = useHotMemoize(module, () => createEnv('proxy')); - - ... - - const apiRouter = Router(); - apiRouter.use('/catalog', await catalog(catalogEnv)); -+ apiRouter.use('/rollbar', await rollbar(rollbarEnv)); - apiRouter.use('/scaffolder', await scaffolder(scaffolderEnv)); -``` - -The following values are read from the configuration file. - -```yaml -rollbar: - accountToken: ${ROLLBAR_ACCOUNT_TOKEN} -``` - -_NOTE: The `ROLLBAR_ACCOUNT_TOKEN` environment variable must be set to a read -access account token._ - -## Links - -- [Frontend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/rollbar) -- [The Backstage homepage](https://backstage.io) +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-rollbar-backend` instead. diff --git a/plugins/rollbar-backend/package.json b/plugins/rollbar-backend/package.json index 4a2d07623f..c7efcccfb1 100644 --- a/plugins/rollbar-backend/package.json +++ b/plugins/rollbar-backend/package.json @@ -3,7 +3,8 @@ "version": "0.1.62", "description": "A Backstage backend plugin that integrates towards Rollbar", "backstage": { - "role": "backend-plugin" + "role": "backend-plugin", + "moved": "@backstage-community/plugin-rollbar-backend" }, "publishConfig": { "access": "public", @@ -58,5 +59,6 @@ "msw": "^1.0.0", "supertest": "^6.1.3" }, - "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-rollbar-backend instead." } diff --git a/plugins/rollbar/README.md b/plugins/rollbar/README.md index 2b1fb7e40d..44b53bc789 100644 --- a/plugins/rollbar/README.md +++ b/plugins/rollbar/README.md @@ -1,66 +1,3 @@ -# Rollbar Plugin +# Deprecated -Website: [https://rollbar.com/](https://rollbar.com/) - -## Setup - -1. Configure the [rollbar backend plugin](https://github.com/backstage/backstage/tree/master/plugins/rollbar-backend/README.md) - -2. If you have standalone app (you didn't clone this repo), then do - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-rollbar -``` - -3. Add to the app `EntityPage` component: - -```tsx -// In packages/app/src/components/catalog/EntityPage.tsx -import { EntityRollbarContent } from '@backstage/plugin-rollbar'; - -const serviceEntityPage = ( - - {/* other tabs... */} - - - -``` - -4. Setup the `app-config.yaml` and account token environment variable - -```yaml -# app.config.yaml -rollbar: - organization: organization-name - # used by rollbar-backend - accountToken: ${ROLLBAR_ACCOUNT_TOKEN} -``` - -5. Annotate entities with the rollbar project slug - -```yaml -# pump-station-catalog-component.yaml -# ... -metadata: - annotations: - rollbar.com/project-slug: organization-name/project-name - # -- or just --- - rollbar.com/project-slug: project-name -``` - -6. Run app with `yarn start` and navigate to `/rollbar` or a catalog entity - -## Features - -- List rollbar entities that are annotated with `rollbar.com/project-slug` -- View top active items for each rollbar annotated entity - -## Limitations - -- Rollbar has rate limits per token - -## Links - -- [Backend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/rollbar-backend) -- [The Backstage homepage](https://backstage.io) +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-rollbar` instead. diff --git a/plugins/rollbar/package.json b/plugins/rollbar/package.json index 263eb41d05..f89dda5620 100644 --- a/plugins/rollbar/package.json +++ b/plugins/rollbar/package.json @@ -3,7 +3,8 @@ "version": "0.4.34", "description": "A Backstage plugin that integrates towards Rollbar", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-rollbar" }, "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-rollbar instead." }