From 64737f447a165d35d141f81a9e3a9d7c4e37826a Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Sun, 29 Nov 2020 10:32:44 +0100 Subject: [PATCH] App/Backend should import techdocs plugin only, not common package If a backstage App wants to enable techdocs plugin, it should only have to care about installing @backstage/plugin-techdocs and @backstage/plugin-techdocs-backend. @backstage/plugin-techdocs-backend should re-export necessary APIs from techdocs-common --- packages/backend/package.json | 1 - packages/backend/src/plugins/techdocs.ts | 5 ++--- .../default-app/packages/backend/src/plugins/techdocs.ts | 4 ++-- plugins/techdocs-backend/src/index.ts | 1 + 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/packages/backend/package.json b/packages/backend/package.json index 158ff043b2..beb2567bd7 100644 --- a/packages/backend/package.json +++ b/packages/backend/package.json @@ -31,7 +31,6 @@ "@backstage/plugin-scaffolder-backend": "^0.3.2", "@backstage/plugin-sentry-backend": "^0.1.3", "@backstage/plugin-techdocs-backend": "^0.3.0", - "@backstage/techdocs-common": "^0.1.1", "@gitbeaker/node": "^25.2.0", "@octokit/rest": "^18.0.0", "azure-devops-node-api": "^10.1.1", diff --git a/packages/backend/src/plugins/techdocs.ts b/packages/backend/src/plugins/techdocs.ts index 25d17801ea..346ea37bac 100644 --- a/packages/backend/src/plugins/techdocs.ts +++ b/packages/backend/src/plugins/techdocs.ts @@ -13,9 +13,8 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - -import { createRouter } from '@backstage/plugin-techdocs-backend'; import { + createRouter, DirectoryPreparer, Preparers, Generators, @@ -23,7 +22,7 @@ import { CommonGitPreparer, UrlPreparer, Publisher, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-backend'; import { PluginEnvironment } from '../types'; import Docker from 'dockerode'; diff --git a/packages/create-app/templates/default-app/packages/backend/src/plugins/techdocs.ts b/packages/create-app/templates/default-app/packages/backend/src/plugins/techdocs.ts index 3b8df8ef21..61af70d981 100644 --- a/packages/create-app/templates/default-app/packages/backend/src/plugins/techdocs.ts +++ b/packages/create-app/templates/default-app/packages/backend/src/plugins/techdocs.ts @@ -1,11 +1,11 @@ import { createRouter, DirectoryPreparer, - CommonGitPreparer, Preparers, Generators, - Publisher, TechdocsGenerator, + CommonGitPreparer, + Publisher, } from '@backstage/plugin-techdocs-backend'; import { PluginEnvironment } from '../types'; import Docker from 'dockerode'; diff --git a/plugins/techdocs-backend/src/index.ts b/plugins/techdocs-backend/src/index.ts index 7612c392a2..5c57882788 100644 --- a/plugins/techdocs-backend/src/index.ts +++ b/plugins/techdocs-backend/src/index.ts @@ -15,3 +15,4 @@ */ export * from './service/router'; +export * from '@backstage/techdocs-common';