Skip to content

Add broken link check action #1165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
44 changes: 44 additions & 0 deletions .github/workflows/broken-link-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Check for broken links

on:
workflow_dispatch: # allow manual trigger
push:
branches:
- main
schedule:
# run daily at 4 am
# * is a special character in YAML so you have to quote this string
- cron: "0 4 * * *"

jobs:
index:
runs-on: ubuntu-latest
steps:
- name: Checking links
uses: ScholliYT/Broken-Links-Crawler-Action@v3
with:
website_url: "https://www.pymc-marketing.io/en/latest/index.html,https://www.pymc-marketing.io/en/latest/getting_started/index.html,https://www.pymc-marketing.io/en/latest/contributing/index.html,https://www.pymc-marketing.io/en/latest/guide/index.html"
# Twitter has a redirect which fails the check, I did a manual check for it and it was working
exclude_url_prefix: "mailto:,https://www.linkedin.com,https://linkedin.com,https://twitter.com"
verbose: "error"
connect_limit_per_host: 50
resolve_before_filtering: "true"
max_retry_time: 30
max_retries: 5
max_depth: 2
docs:
runs-on: ubuntu-latest
steps:
- name: Checking links
uses: ScholliYT/Broken-Links-Crawler-Action@v3
with:
website_url: "https://www.pymc-marketing.io/en/latest/notebooks/index.html"
# Twitter has a redirect which fails the check, I did a manual check for it and it was working
exclude_url_prefix: "mailto:,https://www.linkedin.com,https://linkedin.com,https://twitter.com"
verbose: "error"
connect_limit_per_host: 50
resolve_before_filtering: "true"
max_retry_time: 30
max_retries: 5
max_depth: -1
2 changes: 1 addition & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ See our example notebooks for [saturated markets](https://www.pymc-marketing.io/
### Customer Lifetime Value Modeling in Marine Industry
<iframe width="800" height="450" src="https://www.youtube.com/embed/u3oMWgStIZY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

For more videos, webinars and resources, check out the [PyMC Labs YouTube channel](https://www.youtube.com/@PyMC-Labs).
For more videos, webinars and resources, check out the [PyMC Labs YouTube channel](https://www.youtube.com/PyMC-Labs).

---

Expand Down