From c2a1d8935e55ed8dff9f8e7647b99c0a408137b6 Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Wed, 11 May 2022 09:41:54 +0200 Subject: [PATCH] Use @spotify/techdocs v1.0.3 by default. Signed-off-by: Eric Peterson --- .changeset/techdocs-light-treason.md | 5 +++++ docs/features/techdocs/cli.md | 2 +- plugins/techdocs-node/api-report.md | 2 +- plugins/techdocs-node/src/stages/generate/techdocs.ts | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 .changeset/techdocs-light-treason.md diff --git a/.changeset/techdocs-light-treason.md b/.changeset/techdocs-light-treason.md new file mode 100644 index 0000000000..52136a732d --- /dev/null +++ b/.changeset/techdocs-light-treason.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-techdocs-node': patch +--- + +Updated the default version of the `@spotify/techdocs` container used when `techdocs.generator.runIn` is `docker` to `v1.0.3`. diff --git a/docs/features/techdocs/cli.md b/docs/features/techdocs/cli.md index 9a7dccd5a6..52c389975e 100644 --- a/docs/features/techdocs/cli.md +++ b/docs/features/techdocs/cli.md @@ -120,7 +120,7 @@ Generate TechDocs documentation site using MkDocs. Options: --source-dir Source directory containing mkdocs.yml and docs/ directory. (default: ".") --output-dir Output directory containing generated TechDocs site. (default: "./site/") - --docker-image The mkdocs docker container to use (default: "spotify/techdocs:v1.0.2") + --docker-image The mkdocs docker container to use (default: "spotify/techdocs:v1.0.3") --no-pull Do not pull the latest docker image --no-docker Do not use Docker, use MkDocs executable and plugins in current user environment. --techdocs-ref The repository hosting documentation source files e.g. diff --git a/plugins/techdocs-node/api-report.md b/plugins/techdocs-node/api-report.md index d099f7351a..c584dec40c 100644 --- a/plugins/techdocs-node/api-report.md +++ b/plugins/techdocs-node/api-report.md @@ -219,7 +219,7 @@ export class TechdocsGenerator implements GeneratorBase { config: Config; scmIntegrations: ScmIntegrationRegistry; }); - static readonly defaultDockerImage = 'spotify/techdocs:v1.0.2'; + static readonly defaultDockerImage = 'spotify/techdocs:v1.0.3'; static fromConfig( config: Config, options: GeneratorOptions, diff --git a/plugins/techdocs-node/src/stages/generate/techdocs.ts b/plugins/techdocs-node/src/stages/generate/techdocs.ts index 41b17d3bc6..660b8e8cb5 100644 --- a/plugins/techdocs-node/src/stages/generate/techdocs.ts +++ b/plugins/techdocs-node/src/stages/generate/techdocs.ts @@ -53,7 +53,7 @@ export class TechdocsGenerator implements GeneratorBase { * The default docker image (and version) used to generate content. Public * and static so that techdocs-node consumers can use the same version. */ - public static readonly defaultDockerImage = 'spotify/techdocs:v1.0.2'; + public static readonly defaultDockerImage = 'spotify/techdocs:v1.0.3'; private readonly logger: Logger; private readonly containerRunner: ContainerRunner; private readonly options: GeneratorConfig;