Skip to content

Merge pull request #17242 from travisn/release-1.19.3 #14

Merge pull request #17242 from travisn/release-1.19.3

Merge pull request #17242 from travisn/release-1.19.3 #14

Workflow file for this run

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@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
with:
fetch-depth: 0
- uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c # v6.1.0
with:
go-version: "1.25"
- uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
with:
python-version: 3.9
- uses: DavidAnson/markdownlint-cli2-action@30a0e04f1870d58f8d717450cc6134995f993c63 # v21.0.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 [ ! -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