Merge pull request #20523 from backstage/rugvip/deprecate

deprecate the GraphQL packages

.changeset/light-squids-deny.md

@@ -0,0 +1,6 @@
+---
+'@backstage/plugin-catalog-graphql': minor
+'@backstage/plugin-graphql-backend': minor
+---
+
+This package has been deprecated, consider using [@frontside/backstage-plugin-graphql-backend](https://www.npmjs.com/package/@frontside/backstage-plugin-graphql-backend) instead.

packages/backend/src/index.ts

@@ -55,7 +55,6 @@ import search from './plugins/search';
 import techdocs from './plugins/techdocs';
 import techInsights from './plugins/techInsights';
 import todo from './plugins/todo';
-import graphql from './plugins/graphql';
 import app from './plugins/app';
 import badges from './plugins/badges';
 import jenkins from './plugins/jenkins';
@@ -155,7 +154,6 @@ async function main() {
   const todoEnv = useHotMemoize(module, () => createEnv('todo'));
   const kubernetesEnv = useHotMemoize(module, () => createEnv('kubernetes'));
   const kafkaEnv = useHotMemoize(module, () => createEnv('kafka'));
-  const graphqlEnv = useHotMemoize(module, () => createEnv('graphql'));
   const appEnv = useHotMemoize(module, () => createEnv('app'));
   const badgesEnv = useHotMemoize(module, () => createEnv('badges'));
   const jenkinsEnv = useHotMemoize(module, () => createEnv('jenkins'));
@@ -190,7 +188,6 @@ async function main() {
   apiRouter.use('/kubernetes', await kubernetes(kubernetesEnv));
   apiRouter.use('/kafka', await kafka(kafkaEnv));
   apiRouter.use('/proxy', await proxy(proxyEnv));
-  apiRouter.use('/graphql', await graphql(graphqlEnv));
   apiRouter.use('/badges', await badges(badgesEnv));
   apiRouter.use('/jenkins', await jenkins(jenkinsEnv));
   apiRouter.use('/permission', await permission(permissionEnv));

packages/backend/src/plugins/graphql.ts

@@ -1,28 +0,0 @@
-/*
- * Copyright 2020 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { createRouter } from '@backstage/plugin-graphql-backend';
-import { Router } from 'express';
-import { PluginEnvironment } from '../types';
-
-export default async function createPlugin(
-  env: PluginEnvironment,
-): Promise<Router> {
-  return await createRouter({
-    logger: env.logger,
-    config: env.config,
-  });
-}

plugins/catalog-graphql/README.md

@@ -1,11 +1,3 @@
 # Catalog GraphQL Plugin
 
-## Getting Started
-
-This is the Catalog GraphQL plugin.
-
-It provides the `catalog` part of the GraphQL schema.
-
-To register it with the GraphQL backend, be sure to follow the [Getting Started](../graphql-backend/README.md#getting-started) guide of the GraphQL plugin.
-
-<!-- TODO: Need to make the GraphQL plugin compatible with non forked repos >
+This package has been deprecated, consider using [@frontside/backstage-plugin-graphql-backend](https://www.npmjs.com/package/@frontside/backstage-plugin-graphql-backend) instead.

plugins/catalog-graphql/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-graphql",
-  "description": "An experimental Backstage catalog GraphQL module",
+  "description": "Deprecated, consider using @frontside/backstage-plugin-graphql-backend instead",
   "version": "0.3.24-next.0",
   "main": "src/index.ts",
   "types": "src/index.ts",

plugins/graphql-backend/README.md

@@ -1,28 +1,3 @@
 # GraphQL Backend
 
-## Getting Started
-
-This is the GraphQL Backend plugin.
-
-It is responsible for merging different `graphql-plugins` together to provide the end schema.
-
-To run it within the backend do:
-
-1. Register the router in `packages/backend/src/index.ts`:
-
-```ts
-const graphqlEnv = useHotMemoize(module, () => createEnv('graphql'));
-
-const service = createServiceBuilder(module)
-  .loadConfig(configReader)
-  /** several different routers */
-  .addRouter('/graphql', await graphql(graphqlEnv));
-```
-
-2. Start the backend
-
-```bash
-yarn workspace example-backend start
-```
-
-This will launch the full example backend.
+This package has been deprecated, consider using [@frontside/backstage-plugin-graphql-backend](https://www.npmjs.com/package/@frontside/backstage-plugin-graphql-backend) instead.

plugins/graphql-backend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-graphql-backend",
-  "description": "An experimental Backstage backend plugin for GraphQL",
+  "description": "Deprecated, consider using @frontside/backstage-plugin-graphql-backend instead",
   "version": "0.1.44-next.2",
   "main": "src/index.ts",
   "types": "src/index.ts",