Skip to content

chore(cicd): add daily job to check reference validity#5

Merged
pjhampton merged 2 commits intomainfrom
pjhampton/external-link-check
Jan 23, 2026
Merged

chore(cicd): add daily job to check reference validity#5
pjhampton merged 2 commits intomainfrom
pjhampton/external-link-check

Conversation

@pjhampton
Copy link
Copy Markdown
Member

@pjhampton pjhampton commented Jan 23, 2026

Adds a daily CI job that checks all external HTTP/HTTPS links in the skills directory to ensure they remain valid over time.

Motivation

External links can break over time due to:

  • Domain changes or site restructuring
  • Deprecated documentation pages
  • Service shutdowns
  • URL typos during authoring

This automated check helps maintain documentation quality by detecting broken links before users encounter them.

When run on #2

$ bun src/check-external-links.ts
Checking external links...
Skill directory: /Users/pjhampton/workspace/agent-skills/skills/clickhouse-best-practices

Found 32 files to scan

Found 13 unique external links

Checked 5/13 links...
Checked 10/13 links...
Checked 13/13 links...

================================================================================
External Links Check Summary
================================================================================

┌─────────────────────────────────────────────────────────────────────────────┐
│ URL                                                      │ Status │ Source  │
├──────────────────────────────────────────────────────────┼────────┼─────────┤
│ https://clickhouse.com/docs                              │ 200 ✓  │ ...data.json │
│ https://clickhouse.com/docs/best-practices               │ 200 ✓  │ README.md │
│ https://clickhouse.com/docs/best-practices/avoid-muta... │ 200 ✓  │ ...delete.md │
│ https://clickhouse.com/docs/best-practices/avoid-opti... │ 200 ✓  │ ...-final.md │
│ https://clickhouse.com/docs/best-practices/choosing-a... │ 200 ✓  │ ...ecycle.md │
│ https://clickhouse.com/docs/best-practices/choosing-a... │ 200 ✓  │ ...rderby.md │
│ https://clickhouse.com/docs/best-practices/minimize-o... │ 200 ✓  │ ...before.md │
│ https://clickhouse.com/docs/best-practices/select-dat... │ 200 ✓  │ ...llable.md │
│ https://clickhouse.com/docs/best-practices/selecting-... │ 200 ✓  │ ...h-size.md │
│ https://clickhouse.com/docs/best-practices/use-data-s... │ 200 ✓  │ ...ndices.md │
│ https://clickhouse.com/docs/best-practices/use-json-w... │ 200 ✓  │ ...to-use.md │
│ https://clickhouse.com/docs/best-practices/use-materi... │ 200 ✓  │ ...shable.md │
│ https://github.com/ClickHouse/ClickHouse                 │ 200 ✓  │ ...data.json │
└──────────────────────────────────────────────────────────┴────────┴─────────┘

Summary: 13 links checked, 13 passed, 0 failed

✓ All 13 external links are valid

@pjhampton pjhampton self-assigned this Jan 23, 2026
@pjhampton pjhampton added the enhancement New feature or request label Jan 23, 2026
Copy link
Copy Markdown
Member

@alexkorep alexkorep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script contains a lot of logic, I would consider to add unit tests, maybe as a separate PR?

@pjhampton
Copy link
Copy Markdown
Member Author

The script contains a lot of logic, I would consider to add unit tests, maybe as a separate PR?

SGTM

@pjhampton pjhampton requested a review from a team as a code owner January 23, 2026 14:45
@pjhampton pjhampton merged commit d0e8c00 into main Jan 23, 2026
1 check passed
@pjhampton pjhampton deleted the pjhampton/external-link-check branch January 23, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants