Skip to content

Merge pull request #12808 from go-bai/fix_json_typo #1

Merge pull request #12808 from go-bai/fix_json_typo

Merge pull request #12808 from go-bai/fix_json_typo #1

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
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: Run docs
run: |
make docs
DIFF=$(git diff)
if [ ! -z "$DIFF" ]; then
echo "Please run 'make docs' locally, commit the updated docs, and push the change. See https://rook.io/docs/rook/latest/Contributing/documentation/#running-helm-docs"
fi
git diff --exit-code
- 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