Switched link checker (#5807)

Switch link checker to Lychee in GitHub workflow to reduce false positives and update workflow schedules and documentation links.

Author: brtnfld

.github/workflows/linkchecker.yml

@@ -1,4 +1,4 @@
-name: linkchecker
+name: Link Checker
 
 on:
   workflow_dispatch:
@@ -14,38 +14,98 @@ permissions:
   contents: read
 
 jobs:
-  build:
+  check-links:
+    name: Check Documentation Links
     if: github.event.pull_request.merged == true
     runs-on: ubuntu-latest
     steps:
-      - name: get
+      - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: install
+      - name: Install System Dependencies
         run: |
-          sudo apt install -y libunwind-dev
-          sudo apt install -y graphviz
-          sudo apt install -y --no-install-recommends doxygen
-          sudo apt install -y cmake
-          pip3 install linkchecker
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            libunwind-dev \
+            graphviz \
+            doxygen \
+            cmake
 
-      - name: build
+      - name: Build Documentation
+        id: build_docs
         run: |
           mkdir build
           cd build
           cmake -DHDF5_BUILD_DOC:BOOL=ON ..
           make doxygen
+          echo "html_path=$(pwd)/hdf5lib_docs/html" >> $GITHUB_OUTPUT
 
-      - name: check
+      - name: Run Comprehensive Link Check
+        id: lychee
+        uses: lycheeverse/[email protected]
+        with:
+          args: >
+            --verbose
+            --base ${{ steps.build_docs.outputs.html_path }}
+            --max-retries 4
+            --max-concurrency 8
+            --retry-wait-time 10
+            --timeout 30
+            --user-agent "Mozilla/5.0 (compatible; Lychee/v0.1)"
+            --exclude "eigen.tuxfamily.org"
+            --exclude "gnu.org"
+            --exclude "en.wikipedia.org"
+            --exclude "help.hdfgroup.org"
+            --exclude "libpng.org"
+            --exclude "my.cdash.org"
+            --exclude "www.oreilly.com"
+            --exclude "preshing.com"
+            --exclude "semver.org"
+            --exclude "sourceforge.net"
+            --exclude "www.youtube.com"
+            --exclude "youtu.be"
+            --exclude "hdfeos.org"
+            --exclude "github.com"
+            --exclude "stackoverflow.com"
+            --exclude "reddit.com"
+            --exclude "twitter.com"
+            --exclude "linkedin.com"
+            "${{ steps.build_docs.outputs.html_path }}/**/*.html"
+          output: lychee-report.md
+          format: markdown
+          # Let the action fail naturally - we'll handle it in the summary step
+          fail: true
+
+      - name: Publish Report to Job Summary
+        if: always()
         run: |
-          cd build/hdf5lib_docs/html
-          linkchecker --no-warnings --ignore-url=eigen.tuxfamily.org --ignore-url=/doxygen.css \
-          --ignore-url=gnu.org --ignore-url=en.wikipedia.org \
-          --ignore-url=help.hdfgroup.org --ignore-url=libpng.org \
-          --ignore-url=my.cdash.org --ignore-url=www.oreilly.com \
-          --ignore-url=preshing.com --ignore-url=semver.org \
-          --ignore-url=sourceforge.net --ignore-url=www.youtube.com \
-          --ignore-url=youtu.be \
-          --check-extern --threads=2 ./index.html
-        #continue-on-error: true
+          echo "## 🔗 Link Checker Report" >> "$GITHUB_STEP_SUMMARY"
+          
+          # Check if lychee step succeeded or failed
+          if [ "${{ steps.lychee.outcome }}" = "success" ]; then
+            echo "✅ **No broken links found!**" >> "$GITHUB_STEP_SUMMARY"
+          elif [ "${{ steps.lychee.outcome }}" = "failure" ]; then
+            # Count actual broken links marked with the ❌ emoji.
+            # Default to 0 if grep finds nothing or fails.
+            FAILED_COUNT=$(grep -c "❌" lychee-report.md 2>/dev/null || echo 0)
 
+            if [ "$FAILED_COUNT" -gt 0 ]; then
+              echo "❌ **Found $FAILED_COUNT broken link(s)!**" >> "$GITHUB_STEP_SUMMARY"
+            else
+              # If the step failed but no broken links found, it's likely a different error
+              echo "⚠️ **Link checker encountered an error.**" >> "$GITHUB_STEP_SUMMARY"
+              echo "This may indicate a configuration, network, or file access issue." >> "$GITHUB_STEP_SUMMARY"
+            fi
+          else
+            echo "⚠️ **Link checker step was skipped or cancelled.**" >> "$GITHUB_STEP_SUMMARY"
+          fi
+          
+          echo "" >> "$GITHUB_STEP_SUMMARY"
+          echo "### Full Report:" >> "$GITHUB_STEP_SUMMARY"
+          if [ -f "lychee-report.md" ]; then
+            echo '```' >> "$GITHUB_STEP_SUMMARY"
+            cat lychee-report.md >> "$GITHUB_STEP_SUMMARY"
+            echo '```' >> "$GITHUB_STEP_SUMMARY"
+          else
+            echo "No detailed report available." >> "$GITHUB_STEP_SUMMARY"
+          fi

.github/workflows/update-progress.yml

@@ -2,7 +2,7 @@ name: Release Progress
 
 on:
   schedule:
-    - cron: '0 */24 * * *'  # Run every 24 hours
+    - cron: '0 */4 * * *'  # Run every 4 hours
   workflow_dispatch:  # Allow manual triggering
 
 jobs:

README.md

@@ -19,6 +19,7 @@ HDF5 version 2.0.0-2 currently under development
 [![HDF5 VFD build status](https://img.shields.io/github/actions/workflow/status/HDFGroup/hdf5/vfd.yml?branch=develop&label=HDF5-VFD)](https://github.com/HDFGroup/hdf5/actions/workflows/vfd.yml?query=branch%3Adevelop)
 [![BSD](https://img.shields.io/badge/License-BSD-blue.svg)](https://github.com/HDFGroup/hdf5/blob/develop/LICENSE)
 [![OSS-Fuzz Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/hdf5.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#hdf5)
+[![Link Checker Status](https://github.com/HDFGroup/hdf5/actions/workflows/link-checker.yml/badge.svg)](https://github.com/HDFGroup/hdf5/actions/workflows/link-checker.yml)
 
 [HPC configure/build/test results](https://my.cdash.org/index.php?project=HDF5)
 

doxygen/dox/VFLTechNote.dox

@@ -812,8 +812,8 @@ VFL 'write' routine.</td>
 </table>
 
 See Rajeev Thakur's papers:
-http://www.mcs.anl.gov/~thakur/papers/romio-coll.ps.gz
-http://www.mcs.anl.gov/~thakur/papers/mpio-high-perf.ps.gz
+https://web.cels.anl.gov/~thakur/papers/mpio-impl.pdf
+https://web.cels.anl.gov/~thakur/papers/romio-coll.pdf
 
 \section sec_vfl_reg Registration of a Driver
 Before a driver can be used the HDF5 library needs to be told of its existence. This is done by