feat(techdocs): rename extension point

Signed-off-by: Phil Kuang <pkuang@factset.com>
This commit is contained in:
Phil Kuang
2023-10-16 19:10:46 -04:00
parent 67cff7b06f
commit 31458f5b63
6 changed files with 43 additions and 27 deletions
+19 -6
View File
@@ -20,6 +20,12 @@
* @packageDocumentation
*/
import {
DocsBuildStrategy as _DocsBuildStrategy,
ShouldBuildParameters as _ShouldBuildParameters,
TechDocsDocument as _TechDocsDocument,
} from '@backstage/plugin-techdocs-node';
export { createRouter } from './service';
export type {
RouterOptions,
@@ -37,12 +43,19 @@ export type {
} from './search';
/**
* @deprecated Use directly from @backstage/plugin-techdocs-node
* @public
* @deprecated import from `@backstage/plugin-techdocs-node` instead
*/
export type {
DocsBuildStrategy,
ShouldBuildParameters,
TechDocsDocument,
} from '@backstage/plugin-techdocs-node';
export type DocsBuildStrategy = _DocsBuildStrategy;
/**
* @public
* @deprecated import from `@backstage/plugin-techdocs-node` instead
*/
export type ShouldBuildParameters = _ShouldBuildParameters;
/**
* @public
* @deprecated import from `@backstage/plugin-techdocs-node` instead
*/
export type TechDocsDocument = _TechDocsDocument;
export * from '@backstage/plugin-techdocs-node';
+2 -2
View File
@@ -29,7 +29,7 @@ import {
Preparers,
Generators,
Publisher,
techdocsBuildStrategyExtensionPoint,
techdocsBuildsExtensionPoint,
} from '@backstage/plugin-techdocs-node';
import Docker from 'dockerode';
import { createRouter } from '@backstage/plugin-techdocs-backend';
@@ -42,7 +42,7 @@ export const techdocsPlugin = createBackendPlugin({
pluginId: 'techdocs',
register(env) {
let docsBuildStrategy: DocsBuildStrategy | undefined;
env.registerExtensionPoint(techdocsBuildStrategyExtensionPoint, {
env.registerExtensionPoint(techdocsBuildsExtensionPoint, {
setBuildStrategy(buildStrategy: DocsBuildStrategy) {
if (docsBuildStrategy) {
throw new Error('DocsBuildStrategy may only be set once');