From b10490cedb8d1c90597155327be9f030278d7586 Mon Sep 17 00:00:00 2001 From: Kashish Mittal <113269381+04kash@users.noreply.github.com> Date: Fri, 6 Dec 2024 15:19:23 -0500 Subject: [PATCH] chore: make the deprecation message consistent for all plugins (#2596) chore: make the deprecation message consistent Signed-off-by: Kashish Mittal --- plugins/3scale-backend/README.md | 140 +---------- plugins/acr/README.md | 115 +-------- plugins/analytics-module-matomo/README.md | 2 +- plugins/analytics-provider-segment/README.md | 2 +- plugins/argocd-common/README.md | 15 +- plugins/argocd/README.md | 224 +----------------- plugins/bulk-import-backend/README.md | 2 +- plugins/bulk-import-common/README.md | 2 +- plugins/bulk-import/README.md | 2 +- .../README.md | 7 +- plugins/feedback-backend/README.md | 9 +- plugins/feedback/README.md | 9 +- plugins/jfrog-artifactory/README.md | 2 +- plugins/keycloak-backend/README.md | 2 +- plugins/kubernetes-actions/README.md | 71 +----- plugins/lightspeed-backend/README.md | 2 +- plugins/lightspeed/README.md | 2 +- plugins/matomo-backend/README.md | 2 +- plugins/matomo/README.md | 2 +- plugins/nexus-repository-manager/README.md | 110 +-------- plugins/ocm-backend/README.md | 2 +- plugins/ocm-common/README.md | 2 +- plugins/ocm/README.md | 2 +- plugins/openshift-image-registry/README.md | 2 +- plugins/orchestrator-backend/README.md | 2 +- plugins/orchestrator-common/README.md | 2 +- plugins/orchestrator-form-api/README.md | 2 +- plugins/orchestrator-form-react/README.md | 2 +- .../README.md | 2 +- plugins/orchestrator/README.md | 2 +- plugins/quay-actions/README.md | 2 +- plugins/quay-common/README.md | 2 +- plugins/quay/README.md | 2 +- plugins/rbac-backend/README.md | 2 +- plugins/rbac-common/README.md | 2 +- plugins/rbac-node/README.md | 2 +- plugins/rbac/README.md | 2 +- plugins/regex-actions/README.md | 2 +- plugins/scaffolder-annotator-action/README.md | 111 +-------- plugins/servicenow-actions/README.md | 2 +- plugins/sonarqube-actions/README.md | 2 +- plugins/tekton-common/README.md | 2 +- plugins/tekton/README.md | 2 +- plugins/topology-common/README.md | 2 +- plugins/topology/README.md | 2 +- 45 files changed, 45 insertions(+), 836 deletions(-) diff --git a/plugins/3scale-backend/README.md b/plugins/3scale-backend/README.md index 50897cdf81..4f488b77c5 100644 --- a/plugins/3scale-backend/README.md +++ b/plugins/3scale-backend/README.md @@ -1,142 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-3scale-backend` instead. -Please use the **[@backstage-community/plugin-3scale-backend](https://www.npmjs.com/package/@backstage-community/plugin-3scale-backend)** package instead. - -# 3scale Backstage provider - -The 3scale Backstage provider plugin synchronizes the 3scale content into the [Backstage](https://backstage.io/) catalog. - -## For administrators - -### Installation - -Run the following command to install the 3scale Backstage provider plugin: - -```console -yarn workspace backend add @janus-idp/backstage-plugin-3scale-backend -``` - -### Configuration - -3scale Backstage provider allows configuration of one or multiple providers using the `app-config.yaml` configuration file of Backstage. - -#### Legacy Backend Procedure - -1. Use a `threeScaleApiEntity` marker to start configuring the `app-config.yaml` file of Backstage: - - ```yaml title="app-config.yaml" - catalog: - providers: - threeScaleApiEntity: - dev: - baseUrl: https://-admin.3scale.net - accessToken: - schedule: # optional; same options as in TaskScheduleDefinition - # supports cron, ISO duration, "human duration" as used in code - frequency: { minutes: 30 } - # supports ISO duration, "human duration" as used in code - timeout: { minutes: 3 } - ``` - -2. If installing into the _legacy_ backend, configure the scheduler for the entity provider using one of the following methods: - - - **Method 1**: If the scheduler is configured inside the `app-config.yaml` using the schedule config key mentioned previously, add the following code to `packages/backend/src/plugins/catalog.ts` file: - - ```ts title="packages/backend/src/plugins/catalog.ts" - /* highlight-add-next-line */ - import { ThreeScaleApiEntityProvider } from '@janus-idp/backstage-plugin-3scale-backend'; - - export default async function createPlugin( - env: PluginEnvironment, - ): Promise { - const builder = await CatalogBuilder.create(env); - - /* ... other processors and/or providers ... */ - /* highlight-add-start */ - builder.addEntityProvider( - ThreeScaleApiEntityProvider.fromConfig(env.config, { - logger: env.logger, - scheduler: env.scheduler, - }), - ); - /* highlight-add-end */ - - const { processingEngine, router } = await builder.build(); - await processingEngine.start(); - return router; - } - ``` - - *** - - **NOTE** - - If you have made any changes to the schedule in the `app-config.yaml` file, then restart to apply the changes. - - *** - - - **Method 2**: Add a schedule directly inside the `packages/backend/src/plugins/catalog.ts` file as follows: - - ```ts title="packages/backend/src/plugins/catalog.ts" - /* highlight-add-next-line */ - import { ThreeScaleApiEntityProvider } from '@janus-idp/backstage-plugin-3scale-backend'; - - export default async function createPlugin( - env: PluginEnvironment, - ): Promise { - const builder = await CatalogBuilder.create(env); - - /* ... other processors and/or providers ... */ - /* highlight-add-start */ - builder.addEntityProvider( - ThreeScaleApiEntityProvider.fromConfig(env.config, { - logger: env.logger, - schedule: env.scheduler.createScheduledTaskRunner({ - frequency: { minutes: 30 }, - timeout: { minutes: 3 }, - }), - }), - ); - /* highlight-add-end */ - - const { processingEngine, router } = await builder.build(); - await processingEngine.start(); - return router; - } - ``` - - *** - - **NOTE** - - If both the `schedule` (hard-coded schedule) and `scheduler` (`app-config.yaml` schedule) option are provided in the `packages/backend/src/plugins/catalog.ts`, the `scheduler` option takes precedence. However, if the schedule inside the `app-config.yaml` file is not configured, then the `schedule` option is used. - - *** - -#### New Backend Procedure - -1. If installing into the new backend system, make the same configurations to the `app=config.yaml` as in the [Legacy Backend Installation Procedure](#legacy-backend-installation-procedure). Make sure to configure the schedule inside the `app-config.yaml` file. The default schedule is a frequency of 30 minutes and a timeout of 3 minutes. -2. Add the following code to the `packages/backend/src/index.ts` file: - - ```ts title="packages/backend/src/index.ts" - const backend = createBackend(); - - /* highlight-add-next-line */ - backend.add(import('@janus-idp/backstage-plugin-3scale-backend/alpha')); - - backend.start(); - ``` - -### Troubleshooting - -When you start your Backstage application, you can see some log lines as follows: - -```log -[1] 2023-02-13T15:26:09.356Z catalog info Discovered ApiEntity API type=plugin target=ThreeScaleApiEntityProvider:dev -[1] 2023-02-13T15:26:09.423Z catalog info Discovered ApiEntity Red Hat Event (DEV, v1.2.0) type=plugin target=ThreeScaleApiEntityProvider:dev -[1] 2023-02-13T15:26:09.620Z catalog info Discovered ApiEntity Red Hat Event (TEST, v1.1.0) type=plugin target=ThreeScaleApiEntityProvider:dev -[1] 2023-02-13T15:26:09.819Z catalog info Discovered ApiEntity Red Hat Event (PROD, v1.1.0) type=plugin target=ThreeScaleApiEntityProvider:dev -[1] 2023-02-13T15:26:09.819Z catalog info Applying the mutation with 3 entities type=plugin target=ThreeScaleApiEntityProvider:dev -``` diff --git a/plugins/acr/README.md b/plugins/acr/README.md index 73bcebcc01..b1da98d6d7 100644 --- a/plugins/acr/README.md +++ b/plugins/acr/README.md @@ -1,117 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-acr` instead. -Please use the **[@backstage-community/plugin-acr](https://www.npmjs.com/package/@backstage-community/plugin-acr)** package instead. - -# Azure Container Registry plugin for Backstage - -The Azure Container Registry (ACR) plugin displays information about your container images available in the Azure Container Registry. - -## For administrators - -### Installing and configuring the ACR plugin - -1. Run the following command to install the ACR plugin: - - ```bash - yarn workspace app add @janus-idp/backstage-plugin-acr - ``` - -1. Set the proxy to the desired ACR server in the `app-config.yaml` file as follows: - - ```yaml - # app-config.yaml - proxy: - endpoints: - '/acr/api': - target: 'https://mycontainerregistry.azurecr.io/acr/v1/' - credentials: require - changeOrigin: true - headers: - # If you use Bearer Token for authorization, please replace the 'Basic' with 'Bearer' in the following line. - Authorization: 'Basic ${ACR_AUTH_TOKEN}' - # Change to "false" in case of using self hosted artifactory instance with a self-signed certificate - secure: true - ``` - - > [!NOTE] - > The value inside each route is either a simple URL string, or an object on the format accepted by [http-proxy-middleware](https://www.npmjs.com/package/http-proxy-middleware). Additionally, it has an optional `credentials` key which can have the following values: - > - > - `require`: Callers must provide Backstage user or service credentials with each request. The credentials are not forwarded to the proxy target. This is the **default**. - > - `forward`: Callers must provide Backstage user or service credentials with each request, and those credentials are forwarded to the proxy target. - > - `dangerously-allow-unauthenticated`: No Backstage credentials are required to access this proxy target. The target can still apply its own credentials checks, but the proxy will not help block non-Backstage-blessed callers. If you also add allowedHeaders: ['Authorization'] to an endpoint configuration, then the Backstage token (if provided) WILL be forwarded. - > - > Note that if you have `backend.auth.dangerouslyDisableDefaultAuthPolicy` set to true, the credentials value does not apply; the proxy will behave as if all endpoints were set to dangerously-allow-unauthenticated. - -1. Set the authorization using one of the following options: - - - Basic authorization: - - - Navigate to the ACR portal and go to the **Access Keys** tab. - - Retrieve the username and password of the Admin user and use the [Basic Auth Header Generator tool](https://www.debugbear.com/basic-auth-header-generator) or run `echo printf ':' | base64` in a terminal to convert the credentials into a basic token. - - Set the generated token as `ACR_AUTH_TOKEN` in environment variables. - - - OAuth2: - Generate bearer access token using the process described in Authenticate with an Azure Container Registry. - - - One method is to generate a bearer token using your basic authorization token, i.e. - - ```bash - curl --location 'https://.azurecr.io/oauth2/token?scope=repository%3A*%3A*&service=.azurecr.io' \ - --header 'Authorization: Basic ' - ``` - - - Set the generated token as `ACR_AUTH_TOKEN` in environment variables. Make sure to replace the `Basic` in the `app-config.yaml` with `Bearer` - -1. Enable an additional tab on the entity view page using the `packages/app/src/components/catalog/EntityPage.tsx` file as follows: - - ```tsx title="packages/app/src/components/catalog/EntityPage.tsx" - /* highlight-add-start */ - import { AcrPage, isAcrAvailable } from '@janus-idp/backstage-plugin-acr'; - - /* highlight-add-end */ - - const serviceEntityPage = ( - - // ... - {/* highlight-add-start */} - Boolean(isAcrAvailable(e))} - path="/acr" - title="ACR" - > - - - {/* highlight-add-end */} - - ); - ``` - -1. Annotate your entity using the following annotations: - - ```yaml - metadata: - annotations: - 'azure-container-registry/repository-name': `', - ``` - -## For users - -### Using the ACR plugin in Backstage - -ACR is a front-end plugin that enables you to view information about the container images from your Azure Container Registry in Backstage. - -#### Prerequisites - -- Your Backstage application is installed and running. -- You have installed the ACR plugin. For installation instructions, see [Installing and configuring the ACR plugin](#installing-and-configuring-the-acr-plugin). - -#### Procedure - -1. Open your Backstage application and select a component from the Catalog page. - -1. Go to the **ACR** tab. - - ![acr-tab](./images/acr-plugin-user1.png) - - The **ACR** tab in the Backstage UI contains a list of container images and related information, such as **TAG**, **CREATED**, **LAST MODIFIED**, and **MANIFEST**. diff --git a/plugins/analytics-module-matomo/README.md b/plugins/analytics-module-matomo/README.md index 7967b0b138..37660b2222 100644 --- a/plugins/analytics-module-matomo/README.md +++ b/plugins/analytics-module-matomo/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-analytics-module-matomo` instead. \ No newline at end of file diff --git a/plugins/analytics-provider-segment/README.md b/plugins/analytics-provider-segment/README.md index 1b6b8e5491..d68d6bb697 100644 --- a/plugins/analytics-provider-segment/README.md +++ b/plugins/analytics-provider-segment/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-analytics-provider-segment` instead. \ No newline at end of file diff --git a/plugins/argocd-common/README.md b/plugins/argocd-common/README.md index d572e6eec9..553c751228 100644 --- a/plugins/argocd-common/README.md +++ b/plugins/argocd-common/README.md @@ -1,17 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-redhat-argocd-common` instead. -Please use the **[@backstage-community/plugin-redhat-argocd-common](https://www.npmjs.com/package/@backstage-community/plugin-redhat-argocd-common)** package instead. - -# argocd-common - -Welcome to the argocd-common plugin! - -This plugin contains common utilities for the argocd plugin. - -# Argo CD plugin for Backstage - -The Argocd plugin displays the information about your argocd applications in your Backstage application. - -For more information about Argocd plugin, see the [Argocd plugin documentation](https://github.com/janus-idp/backstage-plugins/tree/main/plugins/argocd) on GitHub. diff --git a/plugins/argocd/README.md b/plugins/argocd/README.md index f2e13e2520..4eef9c4cd4 100644 --- a/plugins/argocd/README.md +++ b/plugins/argocd/README.md @@ -1,225 +1,3 @@ # ❗DEPRECATED❗ -This package has been deprecated. - -Please use the **[@backstage-community/plugin-redhat-argocd](https://www.npmjs.com/package/@backstage-community/plugin-redhat-argocd)** package instead. - -# Argo CD plugin for Backstage - -## Getting started - -Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/argocd/deployment-lifecycle](http://localhost:3000/argocd/deployment-lifecycle). - -You can also serve the plugin in isolation by running `yarn start` in the plugin directory. -This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory. - -## For Administrators - -### Installation and configuration - -#### Prerequisites - -- Install `@roadiehq/backstage-plugin-argo-cd-backend` plugin using the following command from the root directory - - -```bash -yarn workspace app add @roadiehq/backstage-plugin-argo-cd-backend -``` - -- Create plugin file for Argo CD backend in your `packages/backend/src/plugins/` directory. - -```ts -// packages/backend/src/plugins/argocd.ts - -import { createRouter } from '@roadiehq/backstage-plugin-argo-cd-backend'; - -import { PluginEnvironment } from '../types'; - -export default async function createPlugin({ - logger, - config, -}: PluginEnvironment) { - return await createRouter({ logger, config }); -} -``` - -- Modify your backend router to expose the APIs for Argo CD backend - -```ts -// packages/backend/src/index.ts - -import {legacyPlugin} from '@backstage/backend-common'; -... - -backend.add(legacyPlugin('argocd', import('./plugins/argocd'))); -``` - -- add argocd instance information in app.config.yaml - -```ts -argocd: - appLocatorMethods: - - type: 'config' - instances: - - name: argoInstance1 - url: https://argoInstance1.com - username: ${ARGOCD_USERNAME} - password: ${ARGOCD_PASSWORD} - - name: argoInstance2 - url: https://argoInstance2.com - username: ${ARGOCD_USERNAME} - password: ${ARGOCD_PASSWORD} -``` - -#### How to add argocd frontend plugin to Backstage app - -1. Install the Argocd plugin using the following command: - -```bash -yarn workspace app add @janus-idp/backstage-plugin-argocd -``` - -2. Add deployment summary and deployment lifecycle compoennt to the `entityPage.tsx` source file: - -```ts -// packages/app/src/components/catalog/EntityPage.tsx -import { - ArgocdDeploymentSummary, - ArgocdDeploymentLifecycle, - isArgocdConfigured, -} from '@janus-idp/backstage-plugin-argocd'; - -const overviewContent = ( - - ... - - Boolean(isArgocdConfigured(e))}> - - - - - - ... - -); - - -const cicdcontent = ( - - {/* ... */} - {/* highlight-add-start */} - ... - Boolean(isArgocdConfigured(e))}> - - - - - {/* highlight-add-end */} - -); -``` - -- Add one of the following annotations to the entity's `catalog-info.yaml` file to enable Argo CD features in the backstage instance: - - - To get all the applications matching the metadata labels. - - ```yaml - annotations: - ... - - argocd/app-selector: 'rht-gitops.com/janus-argocd=quarkus-app' # format: `label.key=label.value` - - ``` - - **or** - - - To fetch a single application, use the following annotation in `catalog-info.yaml` file: - - ```yaml - annotations: - ... - - argocd/app-name: 'quarkus-app' - - ``` - - > [!Note] > **You should not add both the annotations in the same catalog, adding both annotations will result in error in the plugin.** - -- To switch between argocd instances, you can use the following annotation - -```yaml - annotations: - ... - argocd/instance-name: 'argoInstance2' -``` - -> [!Note] > **If this annotation is not set, the plugin will default to the first Argo CD instance configured in the `app.config.yaml`** - -## Loading as Dynamic Plugin - -To install this plugin into Red Hat Developer Hub or Janus IDP via Helm use this configuration: - -```yaml -global: - dynamic: - includes: - - dynamic-plugins.default.yaml - plugins: - - package: ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic - disabled: false - - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-argocd - disabled: false -``` - -This plugin can be loaded in backstage showcase application as a dynamic plugin. - -Follow the below steps - - -- Export dynamic plugin assets. This will build and create the static assets for the plugin and put it inside dist-scalprum folder. - -`yarn install` - -`yarn tsc` - -`yarn build` - -`yarn export-dynamic` - -- Package and copy dist-scalprum folder assets to dynamic-plugins-root folder in showcase application. - -```sh -pkg=../plugins/argocd -archive=$(npm pack $pkg) -tar -xzf "$archive" && rm "$archive" -mv package $(echo $archive | sed -e 's:\.tgz$::') -``` - -- Add the extension point inside the `app-config.yaml` or `app-config.local.yaml` file. - -```yaml -dynamicPlugins: - frontend: - janus-idp.backstage-plugin-argocd: - mountPoints: - - mountPoint: entity.page.overview/cards - importName: ArgocdDeploymentSummary - config: - layout: - gridColumnEnd: - lg: 'span 8' - xs: 'span 12' - if: - allOf: - - isArgocdAvailable - - mountPoint: entity.page.cd/cards - importName: ArgocdDeploymentLifecycle - config: - layout: - gridColumn: '1 / -1' - if: - allOf: - - isArgocdConfigured -``` - -For more detailed explanation on dynamic plugins follow this [doc](https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/dynamic-plugins.md). +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-redhat-argocd` instead. diff --git a/plugins/bulk-import-backend/README.md b/plugins/bulk-import-backend/README.md index acfd4f071c..674bf20e1b 100644 --- a/plugins/bulk-import-backend/README.md +++ b/plugins/bulk-import-backend/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [redhat-developer/rhdh-plugins](https://github.com/rehdat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-bulk-import-backend` instead. \ No newline at end of file diff --git a/plugins/bulk-import-common/README.md b/plugins/bulk-import-common/README.md index ad2ae39d01..b20f2b6d5e 100644 --- a/plugins/bulk-import-common/README.md +++ b/plugins/bulk-import-common/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [redhat-developer/rhdh-plugins](https://github.com/rehdat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-bulk-import-common` instead. \ No newline at end of file diff --git a/plugins/bulk-import/README.md b/plugins/bulk-import/README.md index 3556d6639c..673d65984c 100644 --- a/plugins/bulk-import/README.md +++ b/plugins/bulk-import/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [redhat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-bulk-import` instead. \ No newline at end of file diff --git a/plugins/catalog-backend-module-scaffolder-relation-processor/README.md b/plugins/catalog-backend-module-scaffolder-relation-processor/README.md index d049f1f906..98ce34c926 100644 --- a/plugins/catalog-backend-module-scaffolder-relation-processor/README.md +++ b/plugins/catalog-backend-module-scaffolder-relation-processor/README.md @@ -1,9 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-catalog-backend-module-scaffolder-relation-processor` instead. -Please use the **[@backstage-community/plugin-catalog-backend-module-scaffolder-relation-processor](https://github.com/backstage/community-plugins/tree/main/workspaces/scaffolder-relation-processor/plugins/catalog-backend-module-scaffolder-relation-processor)** package instead. - -# Catalog Backend Module for Scaffolder Relation Catalog Processor - -This is an extension module to the catalog-backend plugin, providing an additional catalog entity processor that adds a new relation that depends on the `spec.scaffoldedFrom` field to link scaffolder templates and the catalog entities they generated. diff --git a/plugins/feedback-backend/README.md b/plugins/feedback-backend/README.md index ecfd0b68dd..5486cfcd80 100644 --- a/plugins/feedback-backend/README.md +++ b/plugins/feedback-backend/README.md @@ -1,11 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/backstage-plugin-feedback-backend` instead. -Please use the **[@backstage-community/backstage-plugin-feedback-backend](https://github.com/backstage/community-plugins/tree/main/workspaces/feedback/plugins/feedback-backend)** package instead. - -# Feedback Backend - -This is feedback-backend plugin which provides Rest API to create feedbacks. - -It is also responsible for creating JIRA tickets, diff --git a/plugins/feedback/README.md b/plugins/feedback/README.md index 7c9bf174d3..13f6a119ac 100644 --- a/plugins/feedback/README.md +++ b/plugins/feedback/README.md @@ -1,11 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/backstage-plugin-feedback` instead. -Please use the **[@backstage-community/backstage-plugin-feedback](https://github.com/backstage/community-plugins/tree/main/workspaces/feedback/plugins/feedback)** package instead. - -# Feedback Plugin - -Feedback plugin is a valuable addition to backstage which allows project managers to get feedbacks for entites in Backstage Catalog. - -It is dedicated to simplifying the process of gathering and managing user feedback for service catalog entities. This plugin seamlessly integrates with the [feedback-backend-plugin](../feedback-backend) and extends its capabilities by allowing users to create Jira tickets associated with their feedback. diff --git a/plugins/jfrog-artifactory/README.md b/plugins/jfrog-artifactory/README.md index 9c9130fe4b..4b68458ae0 100644 --- a/plugins/jfrog-artifactory/README.md +++ b/plugins/jfrog-artifactory/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-jfrog-artifactory` instead. diff --git a/plugins/keycloak-backend/README.md b/plugins/keycloak-backend/README.md index eeee51709f..de283c7b80 100644 --- a/plugins/keycloak-backend/README.md +++ b/plugins/keycloak-backend/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-catalog-backend-module-keycloak` instead. diff --git a/plugins/kubernetes-actions/README.md b/plugins/kubernetes-actions/README.md index dc137e3fbc..35589a5911 100644 --- a/plugins/kubernetes-actions/README.md +++ b/plugins/kubernetes-actions/README.md @@ -1,73 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-scaffolder-backend-module-kubernetes` instead. -Please use the **[@backstage-community/plugin-scaffolder-backend-module-kubernetes](https://github.com/backstage/community-plugins/tree/main/workspaces/scaffolder-backend-module-kubernetes)** package instead. - -# Kubernetes actions for Backstage - -This module provides [Backstage](https://backstage.io/) template [actions](https://backstage.io/docs/features/software-templates/builtin-actions) for [Kubernetes](https://kubernetes.io/docs/home/). - -The following actions are currently supported in this module: - -- Create a kubernetes namespace - -## Installation - -Run the following command to install the action package in your Backstage project - -```bash -yarn workspace backend add @janus-idp/backstage-scaffolder-backend-module-kubernetes -``` - -### Installing the action on the backend - -Add the following to your `packages/backend/src/index.ts` file: - -```ts title="packages/backend/src/index.ts" -const backend = createBackend(); - -// Add the following line -backend.add( - import('@janus-idp/backstage-scaffolder-backend-module-kubernetes'), -); - -backend.start(); -``` - -## Configuration - -Add the Kubernetes actions to your templates, see the [example](./examples/templates/01-kubernetes-template.yaml) file in this repository for complete usage examples - -```yaml -action: kubernetes:create-namespace -id: create-kubernetes-namespace -name: Create kubernetes namespace -input: - namespace: foo - clusterRef: bar - token: TOKEN - skipTLSVerify: false - caData: Zm9v - labels: app.io/type=ns; app.io/managed-by=org; -``` - -## Usage - -### Action: kubernetes:create-namespace - -#### Input - -| Parameter Name | Type | Required | Description | Example | -| -------------- | :-----: | :------: | --------------------------------------------------- | -------------------------------------- | -| namespace | string | Yes | Kubernetes namespace name | foo | -| clusterRef | string | No | Cluster resource entity reference from the catalog | bar | -| url | string | No | API url of the kubernetes cluster | | -| token | string | No | Kubernetes API bearer token used for authentication | | -| skipTLSVerify | boolean | No | If true, certificate verification is skipped | false | -| caData | string | No | Base64 encoded certificate data | | -| label | string | No | Labels that will be applied to the namespace | app.io/type=ns; app.io/managed-by=org; | - -#### Output - -This action doesn't have any outputs. diff --git a/plugins/lightspeed-backend/README.md b/plugins/lightspeed-backend/README.md index c0602efebc..da754388de 100644 --- a/plugins/lightspeed-backend/README.md +++ b/plugins/lightspeed-backend/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [red-hat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-lightspeed-backend` instead. diff --git a/plugins/lightspeed/README.md b/plugins/lightspeed/README.md index 1cbece7064..7fe18878d7 100644 --- a/plugins/lightspeed/README.md +++ b/plugins/lightspeed/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [red-hat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-lightspeed` instead. diff --git a/plugins/matomo-backend/README.md b/plugins/matomo-backend/README.md index 77649c0c82..7a04475497 100644 --- a/plugins/matomo-backend/README.md +++ b/plugins/matomo-backend/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-matomo-backend` instead. \ No newline at end of file diff --git a/plugins/matomo/README.md b/plugins/matomo/README.md index b92e69b54d..99d62ac105 100644 --- a/plugins/matomo/README.md +++ b/plugins/matomo/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-matomo` instead. \ No newline at end of file diff --git a/plugins/nexus-repository-manager/README.md b/plugins/nexus-repository-manager/README.md index fd72e85de0..cb442431dd 100644 --- a/plugins/nexus-repository-manager/README.md +++ b/plugins/nexus-repository-manager/README.md @@ -1,112 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-nexus-repository-manager` instead. -Please use the **[@backstage-community/plugin-nexus-repository-manager](https://www.npmjs.com/package/@backstage-community/plugin-nexus-repository-manager)** package instead. - -# Nexus Repository Manager plugin for Backstage - -The Nexus Repository Manager plugin displays the information about your build artifacts that are available in the Nexus Repository Manager in your Backstage application. - -## For administrators - -### Installation and configuration - -1. Install the Nexus Repository Manager plugin using the following command: - - ```console - yarn workspace app add @janus-idp/backstage-plugin-nexus-repository-manager - ``` - -1. Set the proxy to the desired Nexus Repository Manager server in the `app-config.yaml` file as follows: - - ```yaml title="app-config.yaml" - proxy: - endpoints: - '/nexus-repository-manager': - target: 'https://' - headers: - X-Requested-With: 'XMLHttpRequest' - # Uncomment the following line to access a private Nexus Repository Manager using a token - # Authorization: 'Bearer ' - changeOrigin: true - # Change to "false" in case of using self hosted Nexus Repository Manager instance with a self-signed certificate - secure: true - ``` - -1. Optional: Change the base URL of Nexus Repository Manager proxy as follows: - - ```yaml title="app-config.yaml" - nexusRepositoryManager: - # default path is `/nexus-repository-manager` - proxyPath: /custom-path - ``` - -1. Optional: Enable experimental annotations: - - ```yaml title="app-config.yaml" - nexusRepositoryManager: - experimentalAnnotations: true - ``` - - Replace the `isNexusRepositoryManagerAvailable` import with `isNexusRepositoryManagerExperimentalAvailable` when adding the `` component. - - **NOTE**: The annotations mentioned in this step are not thoroughly tested. - -1. Enable an additional tab on the service entity page in `packages/app/src/components/catalog/EntityPage.tsx`: - - ```tsx title="packages/app/src/components/catalog/EntityPage.tsx" - /* highlight-add-next-line */ - import { - isNexusRepositoryManagerAvailable, - NexusRepositoryManagerPage, - } from '@janus-idp/backstage-plugin-nexus-repository-manager'; - - const serviceEntityPage = ( - - {/* ... */} - {/* highlight-add-next-line */} - - - - - ); - ``` - - You may also wish to add the route to other component types, such as `library`s. - -1. Annotate your entity with any of the following annotations: - - ```yaml title="catalog-info.yaml" - metadata: - annotations: - # insert the chosen annotations here - # example - nexus-repository-manager/docker.image-name: `/`, - ``` - - For more information about annotations, see the [annotation file](./ANNOTATIONS.md). - -## For users - -### Using the Nexus Repository Manager plugin in Backstage - -The Nexus Repository Manager is a front-end plugin that enables you to view the information about build artifacts. - -#### Prerequisites - -- Your Backstage application is installed and running. -- You have installed the Nexus Repository Manager plugin. For the installation process, see [Installation and configuration](#installation-and-configuration). - -#### Procedure - -1. Open your Backstage application and select a component from the **Catalog** page. -2. Go to the **BUILD ARTIFACTS** tab. - - The **BUILD ARTIFACTS** tab contains a list of build artifacts and related information, such as **VERSION**, **REPOSITORY**, **REPOSITORY TYPE**, **MANIFEST**, **MODIFIED**, and **SIZE**. - - ![nexus-repository-manager-tab](./images/nexus-repository-manager.png) diff --git a/plugins/ocm-backend/README.md b/plugins/ocm-backend/README.md index caebf12b16..d4c9727e57 100644 --- a/plugins/ocm-backend/README.md +++ b/plugins/ocm-backend/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-ocm-backend` instead. \ No newline at end of file diff --git a/plugins/ocm-common/README.md b/plugins/ocm-common/README.md index 5137546fed..d0c6779791 100644 --- a/plugins/ocm-common/README.md +++ b/plugins/ocm-common/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-ocm-common` instead. diff --git a/plugins/ocm/README.md b/plugins/ocm/README.md index c92209698f..3a4f6ab212 100644 --- a/plugins/ocm/README.md +++ b/plugins/ocm/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-ocm` instead. diff --git a/plugins/openshift-image-registry/README.md b/plugins/openshift-image-registry/README.md index 52470038d2..0111e4cfca 100644 --- a/plugins/openshift-image-registry/README.md +++ b/plugins/openshift-image-registry/README.md @@ -1,3 +1,3 @@ -# Deprecated +# # ❗DEPRECATED❗ This package has been moved to the [redhat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-openshift-image-registry` instead. \ No newline at end of file diff --git a/plugins/orchestrator-backend/README.md b/plugins/orchestrator-backend/README.md index f28844c45e..870faa2ff5 100644 --- a/plugins/orchestrator-backend/README.md +++ b/plugins/orchestrator-backend/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [red-hat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-orchestrator-backend` instead. diff --git a/plugins/orchestrator-common/README.md b/plugins/orchestrator-common/README.md index 39e9e68516..f7d191898b 100644 --- a/plugins/orchestrator-common/README.md +++ b/plugins/orchestrator-common/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [red-hat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-orchestrator-common` instead. diff --git a/plugins/orchestrator-form-api/README.md b/plugins/orchestrator-form-api/README.md index 6bbc8d2852..08e56bbf93 100644 --- a/plugins/orchestrator-form-api/README.md +++ b/plugins/orchestrator-form-api/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [red-hat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-orchestrator-form-api` instead. diff --git a/plugins/orchestrator-form-react/README.md b/plugins/orchestrator-form-react/README.md index a3ae3c1b2b..2426ec701b 100644 --- a/plugins/orchestrator-form-react/README.md +++ b/plugins/orchestrator-form-react/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [red-hat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-orchestrator-form-react` instead. diff --git a/plugins/orchestrator-swf-editor-envelope/README.md b/plugins/orchestrator-swf-editor-envelope/README.md index c83d4c62ab..5a26a29fbf 100644 --- a/plugins/orchestrator-swf-editor-envelope/README.md +++ b/plugins/orchestrator-swf-editor-envelope/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [red-hat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-orchestrator-swf-editor-envelope` instead. diff --git a/plugins/orchestrator/README.md b/plugins/orchestrator/README.md index f5149f858f..d228015d28 100644 --- a/plugins/orchestrator/README.md +++ b/plugins/orchestrator/README.md @@ -1,3 +1,3 @@ -# Deprecated +# # ❗DEPRECATED❗ This package has been moved to the [red-hat-developer/rhdh-plugins](https://github.com/redhat-developer/rhdh-plugins) repository. Migrate to using `@red-hat-developer-hub/backstage-plugin-orchestrator` instead. diff --git a/plugins/quay-actions/README.md b/plugins/quay-actions/README.md index 584c6e4a01..81ade29ab1 100644 --- a/plugins/quay-actions/README.md +++ b/plugins/quay-actions/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-scaffolder-backend-module-quay` instead. \ No newline at end of file diff --git a/plugins/quay-common/README.md b/plugins/quay-common/README.md index e8b16731ea..f44cba96de 100644 --- a/plugins/quay-common/README.md +++ b/plugins/quay-common/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-quay-common` instead. diff --git a/plugins/quay/README.md b/plugins/quay/README.md index 55adff97ee..d0e203d671 100644 --- a/plugins/quay/README.md +++ b/plugins/quay/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-quay` instead. diff --git a/plugins/rbac-backend/README.md b/plugins/rbac-backend/README.md index c0bb395008..a62f6f1043 100644 --- a/plugins/rbac-backend/README.md +++ b/plugins/rbac-backend/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-rbac-backend` instead. \ No newline at end of file diff --git a/plugins/rbac-common/README.md b/plugins/rbac-common/README.md index d4ce5114f8..e70a59c759 100644 --- a/plugins/rbac-common/README.md +++ b/plugins/rbac-common/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-rbac-common` instead. diff --git a/plugins/rbac-node/README.md b/plugins/rbac-node/README.md index 5f5c0bfb23..e48f4300b9 100644 --- a/plugins/rbac-node/README.md +++ b/plugins/rbac-node/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-rbac-node` instead. \ No newline at end of file diff --git a/plugins/rbac/README.md b/plugins/rbac/README.md index 910bc3f0fa..e0ad2dd923 100644 --- a/plugins/rbac/README.md +++ b/plugins/rbac/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-rbac` instead. \ No newline at end of file diff --git a/plugins/regex-actions/README.md b/plugins/regex-actions/README.md index d11e75a193..13479cfdeb 100644 --- a/plugins/regex-actions/README.md +++ b/plugins/regex-actions/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/scaffolder-backend-module-regex` instead. \ No newline at end of file diff --git a/plugins/scaffolder-annotator-action/README.md b/plugins/scaffolder-annotator-action/README.md index 149d085952..5b764eb3fe 100644 --- a/plugins/scaffolder-annotator-action/README.md +++ b/plugins/scaffolder-annotator-action/README.md @@ -1,113 +1,4 @@ # ❗DEPRECATED❗ -This package has been deprecated. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-scaffolder-backend-module-annotator` instead. -Please use the **[@backstage-community/plugin-scaffolder-backend-module-annotator](https://github.com/backstage/community-plugins/tree/main/workspaces/scaffolder-backend-module-annotator)** package instead. - -# Annotator custom action for Scaffolder Backstage - -The annotator module for [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend). - -This module allows users to create custom actions for annotating their entity objects. Additionally, it enables users to utilize existing custom actions provided by the module for annotating entities with timestamps and scaffolder entity references. - -## Installation - -### Available custom actions - -| Action | Description | -| ------------------------- | :-----------------------------------------------------------------------------------------------------: | -| `catalog:timestamping` | Adds the `backstage.io/createdAt` annotation containing the current timestamp to your entity object | -| `catalog:scaffolded-from` | Adds `scaffoldedFrom` spec containing the template entityRef to your entity object | -| `catalog:annotate` | Allows you to annotate your entity object with specified label(s), annotation(s) and spec property(ies) | - -To begin, install the module package into the backend workspace of your backstage instance: - -```console -yarn workspace backend add @janus-idp/backstage-scaffolder-backend-module-annotator -``` - -### Registering the annotator action plugin with the backend system - -To install the module into the [backend system](https://backstage.io/docs/backend-system/), add the following into the `packages/backend/src/index.ts` file: - -```ts title="packages/backend/src/index.ts -const backend = createBackend(); - -// highlight-add-start -backend.add(import('@janus-idp/backstage-scaffolder-backend-module-annotator')); -// highlight-add-end - -backend.start(); -``` - -## Creating custom actions for your templates using the annotator module - -### Create the custom action - -#### The `createAnnotatorAction` action accepts the following parameters: - -| Parameter Name | Type | Required | Description | -| ---------------------------------- | :------: | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `actionId` | `string` | Yes | A unique id for the action. Default: `catalog:annotate`, please provide one or else it may conflict with the generic `catalog:annotate` custom action that is provided by this module. | -| `actionDescription` | `string` | No | A description of what the action accomplishes. Default: "Creates a new scaffolder action to annotate the entity object with specified label(s), annotation(s) and spec property(ies)." | -| `loggerInfoMsg` | `string` | No | A message that will be logged upon the execution of the action. Default: "Annotating your object" | -| `annotateEntityObject.labels` | `object` | No | Key-value pairs to be added to the `metadata.labels` of the entity | -| `annotateEntityObject.annotations` | `object` | No | Key-value pairs to be added to the `metadata.annotations` of the entity | -| `annotateEntityObject.spec` | `object` | No | Key-value pairs to be added to the `spec` of the entity. The value for each key can either be a string or an object with the key `readFromContext`, enabling users to specify the path in the context from which the value should be retrieved. | - -1. Create your [custom action](https://backstage.io/docs/features/software-templates/writing-custom-actions#writing-your-custom-action) - -2. Add the annotator module package `@janus-idp/backstage-scaffolder-backend-module-annotator` into your module's `package.json` - -3. In the action file, add the following snippet to it: - -```ts createAddCompanyTitleAction.ts -// highlight-add-start -import { createAnnotatorAction } from '@janus-idp/backstage-scaffolder-backend-module-annotator'; - -export const createAddCompanyTitleAction = () => { - return createAnnotatorAction( - 'catalog:company-title', - 'Creates a new `catalog:company-title` Scaffolder action to annotate scaffolded entities with the company title.', - 'Annotating catalog-info.yaml with the company title', - ); -}; -// highlight-add-end -``` - -4. Install the custom action into your backstage instance following steps similar to the [installation instructions above](#installation) - -### Use your custom action in your desired template(s) - -#### The annotator template action accepts the following inputs - -#### Input - -| Parameter Name | Type | Required | Description | -| ---------------- | :------: | :------: | ------------------------------------------------------------------------------------------------------------------ | -| `labels` | `object` | No | Key-value pairs to be added to the `metadata.labels` of the entity | -| `annotations` | `object` | No | Key-value pairs to be added to the `metadata.annotations` of the entity | -| `spec` | `object` | No | Key-value pairs to be added to the `spec` of the entity | -| `entityFilePath` | `string` | No | The file path from which the YAML representation of the entity should be read | -| `objectYaml` | `object` | No | The YAML representation of the object/entity | -| `writeToFile` | `string` | No | The file path where the YAML representation of the entity should be stored. Default value is './catalog-info.yaml' | - -#### Output - -| Name | Type | Description | -| ----------------- | :------: | -------------------------------------------------------------------------------------------- | -| `annotatedObject` | `object` | The entity object marked with your specified annotation(s), label(s), and spec property(ies) | - -To annotate the entity file, add your custom action to your template file after `Fetch Skeleton + Template` step. Please note that your custom action needs to be installed into the backstage instance running the software template. - -```yaml -// highlight-add-start -- id: company-title - name: Add company title to catalog-info.yaml - action: catalog:company-title - input: - labels: { - company: 'My Company' - } -// highlight-add-end -``` diff --git a/plugins/servicenow-actions/README.md b/plugins/servicenow-actions/README.md index 0293c9ea2b..1f4b38537e 100644 --- a/plugins/servicenow-actions/README.md +++ b/plugins/servicenow-actions/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-scaffolder-backend-module-servicenow` instead. \ No newline at end of file diff --git a/plugins/sonarqube-actions/README.md b/plugins/sonarqube-actions/README.md index 20fa19d457..da80706ec8 100644 --- a/plugins/sonarqube-actions/README.md +++ b/plugins/sonarqube-actions/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-scaffolder-backend-module-sonarqube` instead. \ No newline at end of file diff --git a/plugins/tekton-common/README.md b/plugins/tekton-common/README.md index 53e0db6dce..782f265e67 100644 --- a/plugins/tekton-common/README.md +++ b/plugins/tekton-common/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-tekton-common` instead. diff --git a/plugins/tekton/README.md b/plugins/tekton/README.md index af6428986a..4afc58296c 100644 --- a/plugins/tekton/README.md +++ b/plugins/tekton/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-tekton` instead. \ No newline at end of file diff --git a/plugins/topology-common/README.md b/plugins/topology-common/README.md index f6dcaed91a..358b15a7b1 100644 --- a/plugins/topology-common/README.md +++ b/plugins/topology-common/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-topology-common` instead. \ No newline at end of file diff --git a/plugins/topology/README.md b/plugins/topology/README.md index 3011085310..38c2538a84 100644 --- a/plugins/topology/README.md +++ b/plugins/topology/README.md @@ -1,3 +1,3 @@ -# Deprecated +# ❗DEPRECATED❗ This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-topology` instead. \ No newline at end of file