Skip to content

ci(docs): add link checker to existing CI to prevent broken docs links - #6570

Closed
zyzzmohit wants to merge 1 commit into
pipe-cd:masterfrom
zyzzmohit:feat/docs-link-checker
Closed

ci(docs): add link checker to existing CI to prevent broken docs links#6570
zyzzmohit wants to merge 1 commit into
pipe-cd:masterfrom
zyzzmohit:feat/docs-link-checker

Conversation

@zyzzmohit

Copy link
Copy Markdown
Contributor

Fixes #6549

Adds a lightweight link-checking step using lychee-action to the existing CI workflow that runs only when docs or README files change. It relies on a custom .lychee.toml configuration to ignore localhost, social networks, active repository edit links, and Hugo's internal relative routing paths to avoid false positives.

The action is pinned to its latest SHA (8646ba30) equivalent to v2.8.0 following the repository's existing security conventions.

Does this PR introduce a user-facing change?:

  • How are users affected by this change: No, this is purely a CI pipeline enhancement for maintainers.
  • Is this breaking change: No.
  • How to migrate (if breaking change): N/A

@Ayushmore1214 Ayushmore1214 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work @zyzzmohit Looks good to me!

@zyzzmohit

Copy link
Copy Markdown
Contributor Author

Thanks for the review @Ayushmore1214 I appreciate it :)

@Warashi @khanhtc1202 @ffjlabo Gentle ping on this, Whenever you have a moment, could a maintainer please approve the CI workflows to run and take a look at the proposed changes?

I can also update the branch with the latest master if needed once the CI checks are cleared to run. Let me know if any adjustments are required Thankss

@github-actions

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions Bot added the Stale label Apr 21, 2026
@zyzzmohit

Copy link
Copy Markdown
Contributor Author

Bumping this PR to remove the stale label!

Still actively waiting for a maintainer to trigger the CI workflows and review when you all have a moment. Thanks :)

@khanhtc1202 khanhtc1202 removed the Stale label Apr 21, 2026
@khanhtc1202

Copy link
Copy Markdown
Member

@zyzzmohit Hi, this is a good idea, let me try running this CI on for this PR and see how the output looks like

@zyzzmohit

Copy link
Copy Markdown
Contributor Author

Thank you @khanhtc1202 My apologies, I accidentally synced this branch with master which triggered a new merge commit and paused the CI workflows you were trying to run
Could you please click "Approve and Run" one more time when you get a chance? I will leave the branch completely alone so the tests can finish

Signed-off-by: zyzzmohit <mohitray949@gmail.com>
@zyzzmohit
zyzzmohit force-pushed the feat/docs-link-checker branch from 248963a to d1fb5ce Compare May 20, 2026 17:47
@github-actions

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions Bot added the Stale label Jun 20, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This PR was closed because it has been stalled for 7 days with no activity. Feel free to reopen if still applicable.

@github-actions github-actions Bot closed this Jun 28, 2026
@Ayushmore1214 Ayushmore1214 reopened this Jul 22, 2026

@Ayushmore1214 Ayushmore1214 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @zyzzmohit any updates on this one ?

@Ayushmore1214

Copy link
Copy Markdown
Member

@zyzzmohit last call any updates on this one ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ci(docs): Add link checker to existing CI to prevent broken docs links

3 participants