Merge pull request #17 from autowarefoundation/ci/add-build-docs-check

ci: add docs build check and PR preview for PRs with check-page label

Author: atsushi421

.github/workflows/build-docs.yaml

@@ -0,0 +1,53 @@
+name: build-docs
+
+on:
+  pull_request:
+    types: [labeled, synchronize, closed]
+
+concurrency:
+  group: preview-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  build:
+    if: >-
+      github.event.action != 'closed' &&
+      contains(github.event.pull_request.labels.*.name, 'check-page')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          sudo apt-get update && sudo apt-get install -y doxygen
+
+      - name: Generate API Reference
+        env:
+          BASE_REF: ${{ github.event.pull_request.base.ref }}
+        run: ./generate_api.sh "$BASE_REF"
+
+      - name: Build docs
+        run: mkdocs build -f mkdocs.yaml --strict
+
+      - uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ./site/
+
+  cleanup:
+    if: github.event.action == 'closed'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: rossjrw/pr-preview-action@v1
+        with:
+          action: remove

README.md

@@ -16,3 +16,10 @@ pre-commit install
 ```
 
 From then on, `git commit` will run `markdownlint --fix` automatically against the staged Markdown files.
+
+### Docs build check & PR preview
+
+Apply the `check-page` label to a PR to trigger a full documentation build
+(`mkdocs build --strict`, including Doxygen API reference generation). If the
+build succeeds, a live preview is deployed to GitHub Pages and linked from the
+PR. The preview is removed automatically when the PR is closed.