Update default TechDocs container to v1.0.2

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2022-04-19 13:21:08 +02:00
parent 2c0ed0b012
commit 9fa68705bf
7 changed files with 12 additions and 7 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-techdocs-node': patch
---
The default container version used to generate TechDocs content is now `v1.0.2`.
+1 -1
View File
@@ -120,7 +120,7 @@ Generate TechDocs documentation site using MkDocs.
Options:
--source-dir <PATH> Source directory containing mkdocs.yml and docs/ directory. (default: ".")
--output-dir <PATH> Output directory containing generated TechDocs site. (default: "./site/")
--docker-image <DOCKER_IMAGE> The mkdocs docker container to use (default: "spotify/techdocs:v0.3.6")
--docker-image <DOCKER_IMAGE> The mkdocs docker container to use (default: "spotify/techdocs:v1.0.2")
--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 <HOST_TYPE:URL> The repository hosting documentation source files e.g.
+2 -2
View File
@@ -29,7 +29,7 @@ cd repo
# Install @techdocs/cli, mkdocs and mkdocs plugins
npm install -g @techdocs/cli
pip install mkdocs-techdocs-core==0.*
pip install mkdocs-techdocs-core==1.*
# Generate
techdocs-cli generate --no-docker
@@ -167,7 +167,7 @@ jobs:
run: sudo npm install -g @techdocs/cli
- name: Install mkdocs and mkdocs plugins
run: python -m pip install mkdocs-techdocs-core==0.*
run: python -m pip install mkdocs-techdocs-core==1.*
- name: Generate docs site
run: techdocs-cli generate --no-docker --verbose
+1 -1
View File
@@ -227,7 +227,7 @@ You can do so by including the following lines in the last step of your
```Dockerfile
RUN apt-get update && apt-get install -y python3 python3-pip
RUN pip3 install mkdocs-techdocs-core==0.2.2
RUN pip3 install mkdocs-techdocs-core==1.0.1
```
Please be aware that the version requirement could change, you need to check our
+1 -1
View File
@@ -437,7 +437,7 @@ FROM python:3.8-alpine
RUN apk update && apk --no-cache add gcc musl-dev openjdk11-jdk curl graphviz ttf-dejavu fontconfig
RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==0.2.1
RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==1.0.1
RUN pip install mkdocs-kroki-plugin
+1 -1
View File
@@ -219,7 +219,7 @@ export class TechdocsGenerator implements GeneratorBase {
config: Config;
scmIntegrations: ScmIntegrationRegistry;
});
static readonly defaultDockerImage = 'spotify/techdocs:v0.3.7';
static readonly defaultDockerImage = 'spotify/techdocs:v1.0.2';
static fromConfig(
config: Config,
options: GeneratorOptions,
@@ -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:v0.3.7';
public static readonly defaultDockerImage = 'spotify/techdocs:v1.0.2';
private readonly logger: Logger;
private readonly containerRunner: ContainerRunner;
private readonly options: GeneratorConfig;