63 lines
1.7 KiB
YAML
63 lines
1.7 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
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
docs-check:
|
|
name: docs-check
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
|
|
with:
|
|
go-version: "1.26"
|
|
|
|
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
|
|
with:
|
|
python-version: 3.9
|
|
|
|
- uses: DavidAnson/markdownlint-cli2-action@6bf21b07787794f89a243495939cd651942aeabe # v24.1.0
|
|
with:
|
|
globs: |
|
|
Documentation/**/*.md
|
|
!Documentation/Helm-Charts
|
|
|
|
- name: Check docs
|
|
run: |
|
|
make gen.docs
|
|
tests/scripts/validate_modified_files.sh 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 [ -n "$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
|