Rework checks and add html-with-errors make target (#266)

* Add html-with-errors make target * Check all branches for links and errors * Update badges in README
ros-controls · Apr 16, 2024 · ac653ba · ac653ba
1 parent 9ff1219
commit ac653ba
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 6 deletions.
diff --git a/.github/workflows/sphinx-check-links-pr.yml b/.github/workflows/sphinx-check-links-pr.yml
@@ -0,0 +1,42 @@
+name: "Check Page for Broken Links - PR"
+on:
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+        cache: 'pip'
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install --upgrade --requirement requirements.txt
+      shell: bash
+    - name: Install generate_parameter_library
+      run: |
+        cd
+        git clone https://github.com/PickNikRobotics/generate_parameter_library.git
+        cd generate_parameter_library/generate_parameter_library_py/
+        python -m pip install .
+      shell: bash
+    - name: Install doxygen and graphviz
+      run: sudo apt-get install -y doxygen graphviz
+    - name: Restore stats
+      uses: actions/cache/restore@v4
+      with:
+        key: reviewer-stats-${{ github.run_id }}
+        restore-keys: |
+          reviewer-stats
+        path: ~/reviews
+    - name: Build page with API and run linkchecker
+      run:  |
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        make linkcheck-all-subrepos-with-api
diff --git a/.github/workflows/sphinx-check-links.yml b/.github/workflows/sphinx-check-links.yml
@@ -7,15 +7,19 @@ on:
   schedule:
   # Run every morning to ensure component documentation is up to date on deployment
    - cron: '23 5 * * *'
-  pull_request: # only runs up through build of sphinx
 
 jobs:
   check-links:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        BRANCH: [humble, iron, master]
     steps:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        ref: ${{ matrix.BRANCH }}
     - uses: actions/setup-python@v5
       with:
         python-version: '3.10'

diff --git a/.../workflows/sphinx-check-warnings-iron.yml → .github/workflows/sphinx-check-warnings.yml b/.../workflows/sphinx-check-warnings-iron.yml → .github/workflows/sphinx-check-warnings.yml
@@ -1,4 +1,4 @@
-name: "Check Page for Warnings Iron"
+name: "Check Page for Warnings"
 on:
   workflow_dispatch:
   push:
@@ -11,10 +11,15 @@ on:
 jobs:
   build-halt-on-warnings:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        BRANCH: [humble, iron, master]
     steps:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        ref: ${{ matrix.BRANCH }}
     - uses: actions/setup-python@v5
       with:
         python-version: '3.10'

diff --git a/Makefile b/Makefile
@@ -12,6 +12,7 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS) $(O)
 	@echo "  html-with-api"
+	@echo "  html-with-errors"
 	@echo "  html-all-subrepos"
 	@echo "  html-all-subrepos-with-errors"
 	@echo "  html-all-subrepos-with-api"
@@ -20,8 +21,12 @@ help:
 	@echo "  multiversion-with-errors"
 	@echo "  linkcheck-all-subrepos-with-api"
 
+html-with-errors: Makefile
+	@echo Single version without API, no checkout of sub_repos
+	$(SPHINXBUILD) $(SPHINXOPTS) -W --keep-going $(SOURCEDIR) $(BUILDDIR)/html
+
 html-with-api: Makefile
-	@echo Single html file with API
+	@echo Single version with API
 	@echo Step 1: Creating html files
 	$(SPHINXBUILD) $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
 	@echo Step 2: Building API
@@ -102,7 +107,7 @@ multiversion-with-api: Makefile
 	@echo Step 5: Create correct index
 	@echo "<html><head><meta http-equiv=\"refresh\" content=\"0; url=master/index.html\" /></head></html>" > "$(BUILDDIR)"/html/index.html
 
-.PHONY: help Makefile html-with-api multiversion multiversion-with-api multiversion-with-errors html-all-subrepos html-all-subrepos-with-api html-all-subrepos-with-errors linkcheck-all-subrepos-with-api
+.PHONY: help Makefile html-with-errors html-with-api multiversion multiversion-with-api multiversion-with-errors html-all-subrepos html-all-subrepos-with-api html-all-subrepos-with-errors linkcheck-all-subrepos-with-api
 
 # TODO(denis): Enable this!
 # # # # Generate the doxygen xml (for Sphinx) and copy the doxygen html to the

diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # Status
 
-[![Build & Deploy Page](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml/badge.svg)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml)[![Sphinx Warnings](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-warnings.yml/badge.svg?branch=iron)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-warnings.yml)[![Broken Links](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-links.yml/badge.svg?branch=iron)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-links.yml)
-
+[![Build & Deploy Page](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml/badge.svg)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml)
+[![Broken Links](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-links.yml/badge.svg?branch=master)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-links.yml)
+[![Sphinx Warnings](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-warnings.yml/badge.svg?branch=master)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-warnings.yml)
 
 # control.ros.org
 https://control.ros.org/