From 89ed644ac671cdaaf53990020277274ed5f2e992 Mon Sep 17 00:00:00 2001 From: Sebastian Malton Date: Wed, 25 Nov 2020 16:20:37 -0500 Subject: [PATCH] add step to verify docs on area/documentation PRs Signed-off-by: Sebastian Malton --- .azure-pipelines.yml | 24 ++++++++++++++++++++++++ .gitignore | 1 + package.json | 1 + 3 files changed, 26 insertions(+) diff --git a/.azure-pipelines.yml b/.azure-pipelines.yml index 33dfe83206..bb5b02c3b8 100644 --- a/.azure-pipelines.yml +++ b/.azure-pipelines.yml @@ -162,3 +162,27 @@ jobs: condition: "and(succeeded(), startsWith(variables['Build.SourceBranch'], 'refs/tags/'))" env: NPM_TOKEN: $(NPM_TOKEN) +--- +variables: + YARN_CACHE_FOLDER: $(Pipeline.Workspace)/.yarn +pr: + - master + - releases/* +trigger: + branches: + include: + - '*' + tags: + include: + - "area/documentation" +jobs: + - job: Check-Docs + pool: + vmImage: ubuntu-16.04 + strategy: + matrix: + node_12.x: + node_version: 12.x + steps: + - displayName: Verify that docs build + script: yarn run mkdocs-verify diff --git a/.gitignore b/.gitignore index 93a56f1243..d018f3b251 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,4 @@ types/extension-api.d.ts types/extension-renderer-api.d.ts extensions/*/dist docs/extensions/api +site/ diff --git a/package.json b/package.json index eeda6f6c4c..625303f3f6 100644 --- a/package.json +++ b/package.json @@ -40,6 +40,7 @@ "lint": "yarn run eslint $@ --ext js,ts,tsx --max-warnings=0 src/ integration/ __mocks__/ build/ extensions/", "lint:fix": "yarn run lint --fix", "mkdocs-serve-local": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-serve-local:latest", + "mkdocs-verify": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-serve-local:latest build --strict", "typedocs-extensions-api": "yarn run typedoc --ignoreCompilerErrors --readme docs/extensions/typedoc-readme.md.tpl --name @k8slens/extensions --out docs/extensions/api --mode library --excludePrivate --hideBreadcrumbs --includes src/ src/extensions/extension-api.ts" }, "config": {