Feature dtcenter/METplus#3247 link check (#427)

* Per METplus#3247, adding automated link checking in conjunction with new repo dtcenter/metplus-action-linkcheck

* Resolving error

* Per METplus#3247, add workflow dispatch to the linkcheck PR workflow too

* Per METplus#3247, combine workflows into one file

* Per METplus#3247, added upload-artifact

* Per METplus#3247, modified name and checkout version.

* Unrelated to this PR but updating to resolve deprecated version.

* Unrelated to this PR but updating to resolve deprecated version.

* Unrelated to this PR but updating to resolve deprecated version.

* Modifying workflow to resolve extension error

* Removing main.yaml as a test to resolve a documentation build error.

* Fixing spacing

Author: jprestop

.github/workflows/benchmark_pandas3x.yaml

@@ -79,7 +79,7 @@ jobs:
           echo "Finished benchmark for pandas 2.2"
 
 #      - name: Archive benchmark results
-#        uses: actions/upload-artifact@v4
+#        uses: actions/upload-artifact@v7
 #        with:
 #          name: benchmark-report
 #          path: /home/runner/work/METdataio/METdatio/METreformat/test/**

.github/workflows/documentation.yaml

@@ -25,16 +25,16 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade python-dateutil requests sphinx \
-          sphinx-gallery Pillow sphinx_rtd_theme sphinx-design
+          sphinx-gallery Pillow sphinx_rtd_theme sphinx-panels
           python -m pip install -r docs/requirements.txt
       - name: Build docs
         run: ./.github/jobs/build_documentation.sh
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v7
         if: always()
         with:
           name: documentation
           path: artifact/documentation
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v7
         if: failure()
         with:
           name: documentation_warnings.log

.github/workflows/linkcheck.yml

@@ -0,0 +1,19 @@
+name: Linkcheck
+on:
+  schedule:
+    - cron: '0 6 * * 1'
+  pull_request:
+    paths:
+      - 'docs/**'
+  workflow_dispatch: {}
+
+jobs:
+  linkcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: dtcenter/metplus-action-linkcheck@v1
+        with:
+          fail-on-broken-links: 'true'
+          upload-artifact: 'true'
+          install-package: 'true'

.github/workflows/main.yaml

@@ -78,6 +78,27 @@
     'figure': 'Figure %s',
 }
 
+# -- linkcheck builder configuration ----------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
+
+linkcheck_timeout = 10
+linkcheck_retries = 2
+linkcheck_workers = 8
+
+linkcheck_ignore = [
+    # add regex patterns for URLs that should be skipped, e.g.:
+    # r'https://dtcenter\.org/.*',   # if this site blocks automated requests
+    # r'https://dev\.mysql\.com/doc/.*',    # occasionally slow/rate-limited, not actually broken
+    # r'https://.*\.rap\.ucar\.edu/.*',     # internal DTC/NCAR-network resources unreachable from CI runners
+]
+
+linkcheck_allowed_redirects = {
+    # map of regex -> regex for redirects that are fine to follow
+}
+
+linkcheck_anchors = True
+linkcheck_anchors_ignore = ['^!']
+
 # -- Export variables --------------------------------------------------------
 
 rst_epilog = """