Alexander Trost
a0a1568416
This flow builds the documentation using the `docs-build` target. `mkdocs build --strict` will fail if it detects broken links and other issues. Signed-off-by: Alexander Trost <galexrt@googlemail.com>
37 lines
773 B
YAML
37 lines
773 B
YAML
name: docs-check
|
|
on:
|
|
push:
|
|
tags:
|
|
- v*
|
|
branches:
|
|
- master
|
|
- release-*
|
|
pull_request:
|
|
branches:
|
|
- master
|
|
- release-*
|
|
|
|
# cancel the in-progress workflow when PR is refreshed.
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
docs-check:
|
|
name: docs-check
|
|
runs-on: ubuntu-18.04
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-python@v2
|
|
with:
|
|
python-version: 3.9
|
|
|
|
- name: Install mkdocs and dependencies
|
|
run: cd build/release/ && make deps.docs
|
|
|
|
- name: Build documentation using mkdocs
|
|
run: make docs-build
|