forked from rook/rook
Travis Nielsen
033f6f732e
Use the latest version of Go in the github actions. Support for both Go 1.25 and 1.26 is still available, this only affects the version used by the CI. Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
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@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
|
|
with:
|
|
go-version: "1.26"
|
|
|
|
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
|
|
with:
|
|
python-version: 3.9
|
|
|
|
- uses: DavidAnson/markdownlint-cli2-action@ded1f9488f68a970bc66ea5619e13e9b52e601cd # v23.2.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
|