From 92f11f58766d5e4b1b49cb79984d9e009bbdfb7c Mon Sep 17 00:00:00 2001 From: blnicho Date: Thu, 19 Mar 2026 13:12:08 -0600 Subject: [PATCH 1/6] Add GHA workflow for checking URLs --- .github/workflows/url_check.yml | 36 +++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/workflows/url_check.yml diff --git a/.github/workflows/url_check.yml b/.github/workflows/url_check.yml new file mode 100644 index 0000000..80f40fb --- /dev/null +++ b/.github/workflows/url_check.yml @@ -0,0 +1,36 @@ +name: URL Validation + +on: + push: + branches: + - setup-urlchecker + pull_request: + branches: + - main + schedule: + - cron: '0 3 * * 0' + workflow_dispatch: + inputs: + git-ref: + description: Git Hash (Optional) + required: false + +jobs: + url_check: + runs-on: ubuntu-latest + steps: + - name: Checkout source + uses: actions/checkout@v4 + - name: URL Checker + uses: urlstechie/urlchecker-action@0.0.34 + with: + # A comma-separated list of file types to cover in the URL checks + file_types: .md,.rst,.py + # Choose whether to include file with no URLs in the prints. + print_all: false + # More verbose summary at the end of a run + verbose: true + # How many times to retry a failed request (defaults to 1) + retry_count: 3 + # The timeout seconds to provide to requests, defaults to 5 seconds + timeout: 60 From 99e4b3a58fe0af5342050acf69d6d207c0f05218 Mon Sep 17 00:00:00 2001 From: blnicho Date: Thu, 19 Mar 2026 13:15:32 -0600 Subject: [PATCH 2/6] Remove debugging code --- .github/workflows/url_check.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/url_check.yml b/.github/workflows/url_check.yml index 80f40fb..b7639d1 100644 --- a/.github/workflows/url_check.yml +++ b/.github/workflows/url_check.yml @@ -1,9 +1,6 @@ name: URL Validation on: - push: - branches: - - setup-urlchecker pull_request: branches: - main From 74329261a2c09b728936d4e6e5899a7ff3617550 Mon Sep 17 00:00:00 2001 From: Bethany Nicholson Date: Thu, 19 Mar 2026 13:20:52 -0600 Subject: [PATCH 3/6] Add types to pull_request trigger in url_check.yml --- .github/workflows/url_check.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/url_check.yml b/.github/workflows/url_check.yml index b7639d1..3f84024 100644 --- a/.github/workflows/url_check.yml +++ b/.github/workflows/url_check.yml @@ -4,6 +4,11 @@ on: pull_request: branches: - main + types: + - opened + - reopened + - synchronize + - ready_for_review schedule: - cron: '0 3 * * 0' workflow_dispatch: From 269d68f3dcf8f63887527c079db0ad539ed3ad23 Mon Sep 17 00:00:00 2001 From: blnicho Date: Thu, 19 Mar 2026 13:36:23 -0600 Subject: [PATCH 4/6] Add status badge for URL checker --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0aa22c1..2ce1bbc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![Documentation Status](https://app.readthedocs.org/projects/idaesplus/badge/?version=latest)](https://idaesplus.readthedocs.io/latest) +[![URL Validation](https://github.com/idaesplus/docs/actions/workflows/url_check.yml/badge.svg?branch=main)](https://github.com/idaesplus/docs/actions/workflows/url_check.yml) # IDAES+ Documentation From e4e96a9c18eead1dfd22a1c5d82bf8043ad103dc Mon Sep 17 00:00:00 2001 From: blnicho Date: Thu, 19 Mar 2026 13:44:19 -0600 Subject: [PATCH 5/6] Add yaml to the file types being checked for URLs --- .github/workflows/url_check.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/url_check.yml b/.github/workflows/url_check.yml index 3f84024..65f3e5c 100644 --- a/.github/workflows/url_check.yml +++ b/.github/workflows/url_check.yml @@ -1,6 +1,9 @@ name: URL Validation on: + push: + branches: + -setup-urlchecker pull_request: branches: - main @@ -27,7 +30,7 @@ jobs: uses: urlstechie/urlchecker-action@0.0.34 with: # A comma-separated list of file types to cover in the URL checks - file_types: .md,.rst,.py + file_types: .md,.rst,.py,.yaml # Choose whether to include file with no URLs in the prints. print_all: false # More verbose summary at the end of a run From 1779e022a1e04c5b706b3f65defa6d98003a2796 Mon Sep 17 00:00:00 2001 From: Bethany Nicholson Date: Thu, 19 Mar 2026 13:50:12 -0600 Subject: [PATCH 6/6] Fix branch name formatting in url_check.yml --- .github/workflows/url_check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/url_check.yml b/.github/workflows/url_check.yml index 65f3e5c..a229ee1 100644 --- a/.github/workflows/url_check.yml +++ b/.github/workflows/url_check.yml @@ -3,7 +3,7 @@ name: URL Validation on: push: branches: - -setup-urlchecker + - setup-urlchecker pull_request: branches: - main