Michael Adam
e680f4e302
This simplifies the docs-check workflow definition by extracting functionality
directly coded into the workflow file into new make targets 'check-docs'
and 'check-helm-docs' and replacing the code in the workflow file by the simple invocation of
new make targets. As a side effect, it makes it easily possible for a
developer to check locally if they forgot to commit any autogenerated
docs.
Signed-off-by: Michael Adam <obnox@samba.org>
(cherry picked from commit 04670d3f76)
54 lines
1.3 KiB
YAML
54 lines
1.3 KiB
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-20.04
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-go@v4
|
|
with:
|
|
go-version: "1.21"
|
|
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: 3.9
|
|
|
|
- name: Check helm-docs
|
|
run: make check-helm-docs
|
|
- name: Check docs
|
|
run: make check-docs
|
|
- name: Install mkdocs and dependencies
|
|
run: cd build/release/ && make deps.docs
|
|
|
|
- name: Check documentation for CRDs
|
|
run: |
|
|
make generate-docs-crds
|
|
DIFF_ON_DOCS=$(git diff --ignore-matching-lines='on git commit')
|
|
if [ ! -z "$DIFF_ON_DOCS" ]; then
|
|
echo "Please run 'make generate-docs-crds' locally, commit the updated crds docs, and push the change"
|
|
fi
|
|
git diff --ignore-matching-lines='on git commit' --exit-code
|
|
|
|
- name: Build documentation using mkdocs
|
|
run: make docs-build
|