forked from rook/rook
Pratik Raj
cc921a53f0
Go 1.18.5 and other Go 1.18 version patches provided many vulnerability fixes but as go.mod doesn't support minor version i.e why moving to next go release Signed-off-by: Pratik Raj <rajpratik71@gmail.com>
50 lines
1.2 KiB
YAML
50 lines
1.2 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@v3
|
|
with:
|
|
go-version: 1.19
|
|
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: 3.9
|
|
|
|
- name: Run helm-docs
|
|
run: |
|
|
make helm-docs
|
|
DIFF=$(git diff)
|
|
if [ ! -z "$DIFF" ]; then
|
|
echo "Please run 'make helm-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: Build documentation using mkdocs
|
|
run: make docs-build
|