Skip to content

chore(ci): check for broken links in docs#858

Merged
barjin merged 6 commits into
masterfrom
docs/ci/check-links
Jun 8, 2026
Merged

chore(ci): check for broken links in docs#858
barjin merged 6 commits into
masterfrom
docs/ci/check-links

Conversation

@barjin

@barjin barjin commented Mar 2, 2026

Copy link
Copy Markdown
Member

Split off from #854

Adds automatic CI link checker to check.yaml step. If broken links are detected on a PR, the action comments the PR with a link to the link checker summary.

@barjin barjin self-assigned this Mar 2, 2026
@barjin barjin added the adhoc Ad-hoc unplanned task added during the sprint. label Mar 2, 2026
@github-actions github-actions Bot added this to the 135th sprint - Tooling team milestone Mar 2, 2026
@github-actions github-actions Bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Mar 2, 2026
@danpoletaev danpoletaev force-pushed the docs/ci/check-links branch from 7475ece to e97ac80 Compare March 6, 2026 21:54
@B4nan B4nan force-pushed the docs/ci/check-links branch from e97ac80 to 7475ece Compare March 6, 2026 22:53
@barjin barjin marked this pull request as ready for review June 4, 2026 14:15
@barjin barjin requested a review from szaganek as a code owner June 4, 2026 14:23
@barjin barjin removed the request for review from szaganek June 4, 2026 14:27
@barjin barjin marked this pull request as draft June 4, 2026 14:27
@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

✅ The link checker did not find any broken links.

See more at https://github.com/apify/apify-client-js/actions/runs/26959394670#summary-79545306916

barjin and others added 2 commits June 4, 2026 16:36
The PR comment steps gated on github.event_path instead of
github.event_name, so the condition never matched and no comment was
posted. Also exclude the Docusaurus hashed asset directory from lychee,
since those content-hashed files 410 until the build is deployed.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@barjin barjin marked this pull request as ready for review June 4, 2026 14:52
@barjin barjin requested review from B4nan and szaganek June 4, 2026 14:52

@B4nan B4nan 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.

didnt check the new check much, i guess its a copy paste from somewhere else where it works fine, right?

@barjin

barjin commented Jun 4, 2026

Copy link
Copy Markdown
Member Author

We are using the Lychee checker with a very similar setup in apify-docs, so yes, that one is mostly copy-pasted.

If you want to see how it looks when it fails, check this comment's history.

See that if everything passes in the beginning, there's no comment not to spam the thread too much.

@szaganek szaganek left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Amazing 😎

@barjin barjin merged commit bd673fa into master Jun 8, 2026
7 checks passed
@barjin barjin deleted the docs/ci/check-links branch June 8, 2026 06:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants