Skip to content

ci(developer-hub): add lychee link checker for docs#3552

Open
aditya520 wants to merge 1 commit intomainfrom
claude/nifty-chatelet
Open

ci(developer-hub): add lychee link checker for docs#3552
aditya520 wants to merge 1 commit intomainfrom
claude/nifty-chatelet

Conversation

@aditya520
Copy link
Copy Markdown
Member

@aditya520 aditya520 commented Mar 17, 2026

Summary

  • Add GitHub Actions workflow using lychee to check for broken links in developer-hub docs
  • Triggers on PRs and pushes to main when apps/developer-hub/content/ or apps/developer-hub/src/ files change
  • Add .lycheeignore to suppress false positives (placeholder URLs, OpenAPI spec endpoint)
  • Uses concurrency groups to cancel stale runs on the same PR

Test plan

  • Open a PR that modifies an .mdx file in apps/developer-hub/content/ and verify the workflow runs
  • Introduce a known broken link and confirm the check fails
  • Verify .lycheeignore patterns correctly exclude placeholder URLs

🤖 Generated with Claude Code


Open with Devin

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@aditya520 aditya520 requested a review from a team as a code owner March 17, 2026 13:03
@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-reference Ready Ready Preview, Comment Mar 17, 2026 6:12pm
component-library Ready Ready Preview, Comment Mar 17, 2026 6:12pm
developer-hub Ready Ready Preview, Comment Mar 17, 2026 6:12pm
entropy-explorer Ready Ready Preview, Comment Mar 17, 2026 6:12pm
insights Ready Ready Preview, Comment Mar 17, 2026 6:12pm
proposals Ready Ready Preview, Comment Mar 17, 2026 6:12pm
staking Ready Ready Preview, Comment Mar 17, 2026 6:12pm

Request Review

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d9bd257841

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- "apps/developer-hub/src/**"

concurrency:
group: links-${{ github.head_ref || github.run_id }}
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Scope concurrency group to PR identity

The concurrency key uses github.head_ref, which is only the source branch name, so different pull requests that happen to use the same branch name (for example patch-1 from different forks) will share one group and cancel each other’s runs. This means link checks can be terminated for unrelated PRs, leaving missing or flaky status checks; use a PR-unique value like github.event.pull_request.number (with a push fallback) to ensure cancellation only affects stale runs of the same PR.

Useful? React with 👍 / 👎.

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