From 314b5f084a15568b5e5041a4a8c3d5b977c5bd0a Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 6 Jul 2026 17:55:09 -0600 Subject: [PATCH 1/9] Per METplus#3247, adding automated link checking in conjunction with new repo dtcenter/metplus-action-linkcheck --- .github/workflows/linkcheck_pull_request.yml | 15 +++++++++++++ .github/workflows/linkcheck_scheduled.yml | 15 +++++++++++++ docs/conf.py | 23 +++++++++++++++++++- 3 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/linkcheck_pull_request.yml create mode 100644 .github/workflows/linkcheck_scheduled.yml diff --git a/.github/workflows/linkcheck_pull_request.yml b/.github/workflows/linkcheck_pull_request.yml new file mode 100644 index 00000000..87639a3e --- /dev/null +++ b/.github/workflows/linkcheck_pull_request.yml @@ -0,0 +1,15 @@ +name: linkcheck-pr +on: + pull_request: + paths: + - 'docs/**' + +jobs: + linkcheck: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtcenter/metplus-action-linkcheck@v1 + with: + fail-on-broken-links: 'true' + upload-artifact: 'true' \ No newline at end of file diff --git a/.github/workflows/linkcheck_scheduled.yml b/.github/workflows/linkcheck_scheduled.yml new file mode 100644 index 00000000..7d686935 --- /dev/null +++ b/.github/workflows/linkcheck_scheduled.yml @@ -0,0 +1,15 @@ +name: linkcheck-scheduled +on: + schedule: + - cron: '0 6 * * 1' + workflow_dispatch: {} + +jobs: + linkcheck: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtcenter/metplus-action-linkcheck@v1 + with: + fail-on-broken-links: 'true' + \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index b0a81420..570b4c5e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -99,7 +99,28 @@ numfig_format = { '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://doi\.org/.*', + # r'https://journals\.ametsoc\.org/.*', # AMS journal site blocks bot user-agents +] + +linkcheck_allowed_redirects = { + # map of regex -> regex for redirects that are fine to follow +} + +linkcheck_anchors = True +linkcheck_anchors_ignore = ['^!'] + # -- Export variables -------------------------------------------------------- rst_epilog = """ From 491a06b873de9282e38d2e17839a7b7224ae4b54 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 6 Jul 2026 18:22:59 -0600 Subject: [PATCH 2/9] Resolving error --- .github/workflows/linkcheck_scheduled.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/linkcheck_scheduled.yml b/.github/workflows/linkcheck_scheduled.yml index 7d686935..9eb840b9 100644 --- a/.github/workflows/linkcheck_scheduled.yml +++ b/.github/workflows/linkcheck_scheduled.yml @@ -11,5 +11,4 @@ jobs: - uses: actions/checkout@v4 - uses: dtcenter/metplus-action-linkcheck@v1 with: - fail-on-broken-links: 'true' - \ No newline at end of file + fail-on-broken-links: 'true' \ No newline at end of file From 632af2301611394371b35c6abbc1118ec696f4a3 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 7 Jul 2026 13:17:44 -0600 Subject: [PATCH 3/9] Per METplus#3247, add workflow dispatch to the linkcheck PR workflow too --- .github/workflows/linkcheck_pull_request.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/linkcheck_pull_request.yml b/.github/workflows/linkcheck_pull_request.yml index 87639a3e..481aab60 100644 --- a/.github/workflows/linkcheck_pull_request.yml +++ b/.github/workflows/linkcheck_pull_request.yml @@ -3,7 +3,8 @@ on: pull_request: paths: - 'docs/**' - + workflow_dispatch: {} + jobs: linkcheck: runs-on: ubuntu-latest From 6c68a2ad6a785d2e5c55f24fe2a4723942ba2c37 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 7 Jul 2026 15:09:27 -0600 Subject: [PATCH 4/9] Per METplus#3247, combine workflows into one file --- .../{linkcheck_pull_request.yml => linkcheck.yml} | 6 ++++-- .github/workflows/linkcheck_scheduled.yml | 14 -------------- 2 files changed, 4 insertions(+), 16 deletions(-) rename .github/workflows/{linkcheck_pull_request.yml => linkcheck.yml} (85%) delete mode 100644 .github/workflows/linkcheck_scheduled.yml diff --git a/.github/workflows/linkcheck_pull_request.yml b/.github/workflows/linkcheck.yml similarity index 85% rename from .github/workflows/linkcheck_pull_request.yml rename to .github/workflows/linkcheck.yml index 481aab60..40838861 100644 --- a/.github/workflows/linkcheck_pull_request.yml +++ b/.github/workflows/linkcheck.yml @@ -1,10 +1,12 @@ -name: linkcheck-pr +name: linkcheck on: + schedule: + - cron: '0 6 * * 1' pull_request: paths: - 'docs/**' workflow_dispatch: {} - + jobs: linkcheck: runs-on: ubuntu-latest diff --git a/.github/workflows/linkcheck_scheduled.yml b/.github/workflows/linkcheck_scheduled.yml deleted file mode 100644 index 9eb840b9..00000000 --- a/.github/workflows/linkcheck_scheduled.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: linkcheck-scheduled -on: - schedule: - - cron: '0 6 * * 1' - workflow_dispatch: {} - -jobs: - linkcheck: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: dtcenter/metplus-action-linkcheck@v1 - with: - fail-on-broken-links: 'true' \ No newline at end of file From ca6080bd1dc29cfe7a92d9931e215da610e6c803 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 7 Jul 2026 18:55:04 -0600 Subject: [PATCH 5/9] Per METplus#3247, added upload-artifact --- .github/workflows/linkcheck.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml index 40838861..a976fc11 100644 --- a/.github/workflows/linkcheck.yml +++ b/.github/workflows/linkcheck.yml @@ -15,4 +15,5 @@ jobs: - uses: dtcenter/metplus-action-linkcheck@v1 with: fail-on-broken-links: 'true' - upload-artifact: 'true' \ No newline at end of file + upload-artifact: 'true' + install-package: 'true' \ No newline at end of file From 5392d9ac7782384ba26a7934889e262cc0d02d10 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Jul 2026 14:29:15 -0600 Subject: [PATCH 6/9] Per METplus#3247, modified name and checkout version. --- .github/workflows/linkcheck.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml index a976fc11..305c6dce 100644 --- a/.github/workflows/linkcheck.yml +++ b/.github/workflows/linkcheck.yml @@ -1,4 +1,4 @@ -name: linkcheck +name: Linkcheck on: schedule: - cron: '0 6 * * 1' @@ -11,7 +11,7 @@ jobs: linkcheck: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - uses: dtcenter/metplus-action-linkcheck@v1 with: fail-on-broken-links: 'true' From 2089de39e8595398a9873b5cc765d266f8b1ae28 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 27 Jul 2026 13:42:31 -0600 Subject: [PATCH 7/9] Unrelated to this PR but updating to resolve deprecated version. --- .github/workflows/documentation.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index ec3cf67f..ea56302f 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -28,12 +28,12 @@ jobs: 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 From b8f5d328a5d3a49e2ee487b82e85d833ba9dcc48 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 27 Jul 2026 17:14:13 -0600 Subject: [PATCH 8/9] Unrelated to this PR, but updating upload-artifact version --- .github/workflows/unit_tests.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/unit_tests.yaml b/.github/workflows/unit_tests.yaml index 26852760..12bd051d 100644 --- a/.github/workflows/unit_tests.yaml +++ b/.github/workflows/unit_tests.yaml @@ -54,7 +54,7 @@ jobs: coverage html - name: Archive code coverage results - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: code-coverage-report_py${{ matrix.python-version }} path: htmlcov/index.html From df4532fa0ca41f3bb6f6369f5e3824ae20924f72 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 27 Jul 2026 17:14:36 -0600 Subject: [PATCH 9/9] Unrelated to this PR, but updating upload-artifact version --- .github/workflows/version_tests.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/version_tests.yaml b/.github/workflows/version_tests.yaml index ba3086cf..c90d186a 100644 --- a/.github/workflows/version_tests.yaml +++ b/.github/workflows/version_tests.yaml @@ -55,7 +55,7 @@ jobs: coverage html - name: Archive code coverage results - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: code-coverage-report path: htmlcov/index.html