From b241ad093b6a2eb916768242e9b6faab26e7283f Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:49:10 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713466146663.md | 5 ++ plugins/octopus-deploy/README.md | 135 +--------------------------- plugins/octopus-deploy/package.json | 6 +- 3 files changed, 11 insertions(+), 135 deletions(-) create mode 100644 .changeset/migrate-1713466146663.md diff --git a/.changeset/migrate-1713466146663.md b/.changeset/migrate-1713466146663.md new file mode 100644 index 0000000000..8f83f146a1 --- /dev/null +++ b/.changeset/migrate-1713466146663.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-octopus-deploy': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/octopus-deploy/README.md b/plugins/octopus-deploy/README.md index 745a1793e8..521d940afe 100644 --- a/plugins/octopus-deploy/README.md +++ b/plugins/octopus-deploy/README.md @@ -1,134 +1,3 @@ -# Octopus Deploy Plugin +# Deprecated -Welcome to the octopus-deploy plugin! - -## Features - -- Display the deployment status of the most recent releases for a project in Octopus Deploy straight from the Backstage catalog - -## Getting started - -### Installing - -To get started, first install the plugin with the following command: - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-octopus-deploy -``` - -### Setup - -This plugin (currently) uses the Backstage proxy to securely communicate with the Octopus Deploy API. - -To use it, you will need to generate an [API Key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key) within Octopus Deploy. - -Add the following to your app-config.yaml to enable the proxy: - -``` -// app-config.yaml -proxy: - endpoints: - '/octopus-deploy': - target: 'https:///api' - headers: - X-Octopus-ApiKey: ${OCTOPUS_API_KEY} -``` - -Optionally, also add the following section to your app-config.yaml if you wish to enable linking to the Project Release page in the Octopus Deploy UI from the footer of the Backstage Release Table. Typically this will be the server URL above without the /api postfix. - -``` -octopusdeploy: - webBaseUrl: "" -``` - -#### Adding the Entities - -Add the following to `EntityPage.tsx` to display Octopus Releases - -``` -// In packages/app/src/components/catalog/EntityPage.tsx -import { - isOctopusDeployAvailable, - EntityOctopusDeployContent -} from '@backstage/plugin-octopus-deploy'; - -const cicdContent = ( - - {/* other components... */} - - - - -) -``` - -Add `octopus.com/project-id` annotation in the catalog descriptor file. - -To obtain a projects ID you will have to query the Octopus API. In the future we'll add support for using a projects slug as well. - -``` -// catalog-info.yaml -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - # ... - annotations: - octopus.com/project-id: Projects-102 -spec: - type: service -``` - -If your project is not part of the default space you can add the space ID to the annotation as a prefix. For example: - -``` -// catalog-info.yaml -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - # ... - annotations: - octopus.com/project-id: Spaces-2/Projects-102 -spec: - type: service -``` - -You can get the ID of the space from the URL in the Octopus Deploy UI. - -All set, you will be able to see the plugin in action! - -### Adding Scaffolder field extensions - -To add the Octopus Deploy custom fields extensions, add the following to your `App.tsx`: - -```tsx -// In packages/app/src/App.tsx -import { OctopusDeployDropdownFieldExtension } from '@backstage/plugin-octopus-deploy'; -const routes = ( - - ... - }> - - - - - ... - -``` - -To use the Octopus Deploy custom field extensions, add the following to your `template.yaml`: - -```yaml -# In the template.yaml -apiVersion: scaffolder.backstage.io/v1beta3 -kind: Template -metadata: - # ... - parameters: - - title: Octopus Project Group - properties: - projectName: - title: Octopus Project Group - type: string - ui:field: OctopusDeployProjectGroupDropdown -``` +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-octopus-deploy` instead. diff --git a/plugins/octopus-deploy/package.json b/plugins/octopus-deploy/package.json index 336c487a42..3fffb0ef45 100644 --- a/plugins/octopus-deploy/package.json +++ b/plugins/octopus-deploy/package.json @@ -2,7 +2,8 @@ "name": "@backstage/plugin-octopus-deploy", "version": "0.2.16", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-octopus-deploy" }, "publishConfig": { "access": "public", @@ -54,5 +55,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-octopus-deploy instead." }