diff --git a/.changeset/migrate-1713466234510.md b/.changeset/migrate-1713466234510.md new file mode 100644 index 0000000000..42eed581f0 --- /dev/null +++ b/.changeset/migrate-1713466234510.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-stackstorm': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/stackstorm/README.md b/plugins/stackstorm/README.md index 0d5caeaca2..404cff38ab 100644 --- a/plugins/stackstorm/README.md +++ b/plugins/stackstorm/README.md @@ -1,61 +1,3 @@ -# StackStorm Plugin +# Deprecated -Welcome to the StackStorm plugin! - -A Backstage integration for the [StackStorm](https://docs.stackstorm.com/overview.html). -This plugin allows you to display a list of executions, view execution details, -browse installed packs, actions and more. - -## Getting started - -To get started, first you need a running instance of StackStorm. -One of the quickest ways is [running StackStorm with Docker](https://docs.stackstorm.com/install/docker.html). - -### Installation - -1. Install the plugin with `yarn` in the root of your Backstage directory - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-stackstorm -``` - -2. Import and use the plugin in `packages/app/src/App.tsx` - -```tsx -import { StackstormPage } from '@backstage/plugin-stackstorm'; - -const routes = ( - - {/* ...other routes */} - } /> - -``` - -### Configuration - -1. Configure `webUrl` for links to the StackStorm Web UI in `app-config.yaml`. - -```yaml -stackstorm: - webUrl: 'https://your.stackstorm.webui.com' -``` - -2. Configure `stackstorm` proxy - This plugin uses the Backstage proxy to securely communicate with StackStorm API. - Add the following to your `app-config.yaml` to enable this configuration: - -```yaml -proxy: - '/stackstorm': - target: https://your.stackstorm.instance.com/api - headers: - St2-Api-Key: ${ST2_API_KEY} -``` - -In your production deployment of Backstage, you would also need to ensure that -you've set the `ST2_API_KEY` environment variable before starting -the backend. - -Read more about how to find or generate this key in the -[StackStorm Authentication Documentation](https://docs.stackstorm.com/authentication.html#api-keys). +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-stackstorm` instead. diff --git a/plugins/stackstorm/package.json b/plugins/stackstorm/package.json index 36510d02b5..f33d2dc0e6 100644 --- a/plugins/stackstorm/package.json +++ b/plugins/stackstorm/package.json @@ -3,7 +3,8 @@ "version": "0.1.15", "description": "A Backstage plugin that integrates towards StackStorm", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-stackstorm" }, "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-stackstorm instead." }