From d829d1331febd48b7ff0be7e08850648655f197c Mon Sep 17 00:00:00 2001 From: Leandro Damascena Date: Thu, 17 Jul 2025 12:37:03 +0100 Subject: [PATCH] Add a new workflow to build docs on new PRs --- .github/workflows/quality_check.yml | 2 +- .github/workflows/quality_check_docs.yml | 50 ++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/quality_check_docs.yml diff --git a/.github/workflows/quality_check.yml b/.github/workflows/quality_check.yml index 0cfeac0e6e5..616af6f28cf 100644 --- a/.github/workflows/quality_check.yml +++ b/.github/workflows/quality_check.yml @@ -1,4 +1,4 @@ -name: Code quality +name: Quality check - check code # PROCESS # diff --git a/.github/workflows/quality_check_docs.yml b/.github/workflows/quality_check_docs.yml new file mode 100644 index 00000000000..908683cf71d --- /dev/null +++ b/.github/workflows/quality_check_docs.yml @@ -0,0 +1,50 @@ +name: Quality check - Build docs + +# PROCESS +# +# 1. Install all dependencies required to build the docs +# 2. Build the docs + +# USAGE +# +# Always triggered on new PRs, PR changes and PR merge. + + +on: + pull_request: + paths: + - "docs/**" + - "examples/**" + - "mkdocs.yml" + branches: + - develop + push: + paths: + - "docs/**" + - "examples/**" + - "mkdocs.yml" + branches: + - develop + +permissions: + contents: read + +jobs: + build_docs: + runs-on: ubuntu-latest + permissions: + contents: read # checkout code only + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + - name: Set up Python + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 + with: + python-version: 3.13 + - name: Install doc generation dependencies + run: | + cat docs/requirements.txt + pip install --require-hashes -r docs/requirements.txt + - name: Build docs + run: | + rm -rf site + mkdocs build