From 47277c0d8cc032bbd536bb8af741a819c69b12a8 Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Mon, 17 Jan 2022 17:34:01 +0100 Subject: [PATCH] Bump @spotify/techdocs container to v0.3.6 Signed-off-by: Eric Peterson --- .changeset/techdocs-glob-glob-glob.md | 5 +++++ docs/features/techdocs/cli.md | 2 +- packages/techdocs-common/api-report.md | 2 +- packages/techdocs-common/src/stages/generate/techdocs.ts | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 .changeset/techdocs-glob-glob-glob.md diff --git a/.changeset/techdocs-glob-glob-glob.md b/.changeset/techdocs-glob-glob-glob.md new file mode 100644 index 0000000000..b177942c94 --- /dev/null +++ b/.changeset/techdocs-glob-glob-glob.md @@ -0,0 +1,5 @@ +--- +'@backstage/techdocs-common': patch +--- + +Updated the default version of the `@spotify/techdocs` container used when `techdocs.generator.runIn` is `docker` to `v0.3.6`, which includes an update to `mkdocs-monorepo-plugin` that allows glob-based wildcard includes. diff --git a/docs/features/techdocs/cli.md b/docs/features/techdocs/cli.md index 30cb8314a0..8122fefdcd 100644 --- a/docs/features/techdocs/cli.md +++ b/docs/features/techdocs/cli.md @@ -119,7 +119,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:v0.3.4") + --docker-image The mkdocs docker container to use (default: "spotify/techdocs:v0.3.6") --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/packages/techdocs-common/api-report.md b/packages/techdocs-common/api-report.md index 5cb2d81b1d..281accca30 100644 --- a/packages/techdocs-common/api-report.md +++ b/packages/techdocs-common/api-report.md @@ -227,7 +227,7 @@ export class TechdocsGenerator implements GeneratorBase { config: Config; scmIntegrations: ScmIntegrationRegistry; }); - static readonly defaultDockerImage = 'spotify/techdocs:v0.3.5'; + static readonly defaultDockerImage = 'spotify/techdocs:v0.3.6'; // (undocumented) static fromConfig( config: Config, diff --git a/packages/techdocs-common/src/stages/generate/techdocs.ts b/packages/techdocs-common/src/stages/generate/techdocs.ts index a6eb8d38d2..7f182c7e6c 100644 --- a/packages/techdocs-common/src/stages/generate/techdocs.ts +++ b/packages/techdocs-common/src/stages/generate/techdocs.ts @@ -44,7 +44,7 @@ export class TechdocsGenerator implements GeneratorBase { * The default docker image (and version) used to generate content. Public * and static so that techdocs-common consumers can use the same version. */ - public static readonly defaultDockerImage = 'spotify/techdocs:v0.3.5'; + public static readonly defaultDockerImage = 'spotify/techdocs:v0.3.6'; private readonly logger: Logger; private readonly containerRunner: ContainerRunner; private readonly options: GeneratorConfig;