diff --git a/.github/workflows/url_check.yml b/.github/workflows/url_check.yml new file mode 100644 index 0000000..a229ee1 --- /dev/null +++ b/.github/workflows/url_check.yml @@ -0,0 +1,41 @@ +name: URL Validation + +on: + push: + branches: + - setup-urlchecker + pull_request: + branches: + - main + types: + - opened + - reopened + - synchronize + - ready_for_review + 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,.yaml + # 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 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