Skip to content

ci: add live URL audit (weekly cron) + grandfather current broken URLs#11

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/url-check-ci
May 15, 2026
Merged

ci: add live URL audit (weekly cron) + grandfather current broken URLs#11
Jammy2211 merged 1 commit into
mainfrom
feature/url-check-ci

Conversation

@Jammy2211
Copy link
Copy Markdown
Collaborator

Summary

Add the live URL-audit CI infrastructure described in PyAutoLabs/PyAutoBuild#87 to HowToLens.

  • .url_check_allowlist.txt at repo root — 9 URLs the audit currently flags as broken in this repo. Mostly external paywalled / dead links and internal docs renames. Each is grouped by category with the originating file:line as an inline comment.
  • .github/workflows/url_check.yml — extended:
    • Offline regex guard (existing job, expanded to ~17 patterns) — runs on every PR + push. Fast, no network. Catches typos like hhttps://, stale Jammy2211/ refs, etc.
    • Live HTTP audit (NEW) — runs on schedule (Monday 04:00 UTC) and workflow_dispatch. Validates every URL in the repo's docs against the allowlist. On new breakage, opens or appends to a tracking issue titled [url-check] New broken URLs detected. On a clean run, automatically closes any prior open tracking issue.

No code changes. Doc / CI-only.

Test plan

  • Workflow YAML parses
  • url_check_live.sh HowToLens exits 0 against the current allowlist (post-merge cron run will be a no-op until something new breaks)
  • First weekly cron run after merge confirms the issue-create path works end-to-end

Related

Add .url_check_allowlist.txt at repo root containing the 9 broken URLs
the audit currently flags in HowToLens — mostly external paywalled / dead
links and a few internal docs renames that need editorial fixes. The
weekly cron job will only fail when a NEW broken URL appears that isn't
in this file.

Update .github/workflows/url_check.yml:
  - keep the existing offline regex guard (runs on every PR + push, now
    with ~15 additional bad patterns thanks to the matching PyAutoBuild
    extension)
  - add a url_check_live job that runs on schedule (Mon 04:00 UTC) and
    workflow_dispatch. On non-zero exit it opens or comments on a
    [url-check] New broken URLs detected tracking issue.
  - on a clean run, auto-closes any prior open [url-check] issue.

Tool: PyAutoLabs/PyAutoBuild#87 (paired PR — must merge first for the
extended regex patterns and the new live tool to be available).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Jammy2211 Jammy2211 merged commit 3f038eb into main May 15, 2026
6 checks passed
@Jammy2211 Jammy2211 deleted the feature/url-check-ci branch May 15, 2026 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant