Use @backstage/plugin-techdocs-node instead of @backstage/techdocs-common

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2022-03-03 13:33:47 +01:00
parent 84a8788794
commit 91bf1e6c1a
34 changed files with 54 additions and 47 deletions
@@ -21,7 +21,7 @@ import Docker from 'dockerode';
import {
TechdocsGenerator,
ParsedLocationAnnotation,
} from '@backstage/techdocs-common';
} from '@backstage/plugin-techdocs-node';
import { DockerContainerRunner } from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import {
@@ -31,7 +31,7 @@ import {
import { stdout } from 'process';
export default async function generate(cmd: Command) {
// Use techdocs-common package to generate docs. Keep consistency between Backstage and CI generating docs.
// Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.
// Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow
// will run on the CI pipeline containing the documentation files.
@@ -78,7 +78,7 @@ export default async function generate(cmd: Command) {
}
}
// Generate docs using @backstage/techdocs-common
// Generate docs using @backstage/plugin-techdocs-node
const techdocsGenerator = await TechdocsGenerator.fromConfig(config, {
logger,
containerRunner,
+1 -1
View File
@@ -15,7 +15,7 @@
*/
import { CommanderStatic } from 'commander';
import { TechdocsGenerator } from '@backstage/techdocs-common';
import { TechdocsGenerator } from '@backstage/plugin-techdocs-node';
const defaultDockerImage = TechdocsGenerator.defaultDockerImage;
@@ -15,7 +15,7 @@
*/
import { SingleHostDiscovery } from '@backstage/backend-common';
import { Publisher } from '@backstage/techdocs-common';
import { Publisher } from '@backstage/plugin-techdocs-node';
import { Command } from 'commander';
import { createLogger } from '../../lib/utility';
import { PublisherConfig } from '../../lib/PublisherConfig';
@@ -18,7 +18,7 @@ import { resolve } from 'path';
import { Command } from 'commander';
import { createLogger } from '../../lib/utility';
import { SingleHostDiscovery } from '@backstage/backend-common';
import { Publisher } from '@backstage/techdocs-common';
import { Publisher } from '@backstage/plugin-techdocs-node';
import { Entity } from '@backstage/catalog-model';
import { PublisherConfig } from '../../lib/PublisherConfig';
+1 -1
View File
@@ -16,7 +16,7 @@
import {
RemoteProtocol,
ParsedLocationAnnotation,
} from '@backstage/techdocs-common';
} from '@backstage/plugin-techdocs-node';
import * as winston from 'winston';
export const convertTechDocsRefToLocationAnnotation = (