add step to verify docs on area/documentation PRs (#1528)

* add step to verify docs on area/documentation PRs

* use GH actions to run the verification

* add check if label is set to area/documentation

* fix broken links in docs with WIP files

* add generating API docs before verifying

Signed-off-by: Sebastian Malton <sebastian@malton.name>
This commit is contained in:
Sebastian Malton authored and GitHub committed 2020-11-27 10:13:53 -05:00
1 parent b3fd2232b5
commit 686cb122a3
9 files changed
+68 -4

No files matched your search

+6 -3
View File
@@ -4,7 +4,7 @@ on:
branches:
- master
release:
types:
types:
- published
jobs:
build:
@@ -46,6 +46,10 @@ jobs:
yarn install
yarn typedocs-extensions-api
- name: Verify that the markdown is valid
run: |
yarn run verify-docs
- name: mkdocs deploy master
if: contains(github.ref, 'refs/heads/master')
run: |
@@ -55,10 +59,9 @@ jobs:
if: contains(github.ref, 'refs/tags/v') # && !github.event.release.prerelease (generate pre-release docs until Lens 4.0.0 is GA, see #1408)
id: get_version
run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
- name: mkdocs deploy new release
if: contains(github.ref, 'refs/tags/v') # && !github.event.release.prerelease (generate pre-release docs until Lens 4.0.0 is GA, see #1408)
run: |
mike deploy --push --update-aliases ${{ steps.get_version.outputs.VERSION }} latest
mike set-default --push ${{ steps.get_version.outputs.VERSION }}