Skip to content

ci: add link-check workflow (lychee)#16

Merged
github-actions[bot] merged 1 commit into
mainfrom
ci/link-check
May 13, 2026
Merged

ci: add link-check workflow (lychee)#16
github-actions[bot] merged 1 commit into
mainfrom
ci/link-check

Conversation

@satyakwok
Copy link
Copy Markdown
Member

@satyakwok satyakwok commented May 13, 2026

Same pattern as awesome-sentrix's link-check workflow. Lychee scans every markdown link on PR + push to main + a weekly Monday 03:00 UTC cron. Non-blocking, mirroring gitleaks policy.

Summary by CodeRabbit

  • Chores
    • Implemented automated link validation for documentation to detect and prevent broken references.

Review Change Stack

Same pattern as awesome-sentrix — lychee scans every markdown link on
PR + push to main + a weekly Monday 03:00 UTC cron. Non-blocking,
mirroring the gitleaks workflow's policy. Catches link rot between
releases without gating merges.
@github-actions github-actions Bot enabled auto-merge (squash) May 13, 2026 08:21
@github-actions github-actions Bot merged commit fe03414 into main May 13, 2026
5 of 6 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR adds a new GitHub Actions workflow file to automate checking for dead links in markdown documentation. The link-check workflow runs on pull requests, pushes to the main branch, a weekly Monday schedule, and manual trigger. It scans all **/*.md files using lycheeverse/lychee-action, excludes mail-related links, configures concurrency limits, and returns non-blocking output so link findings do not fail the workflow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • Sentriscloud/dapp-starter#13: Modifies GitHub Actions workflows to pin third-party action references to specific commit SHAs for supply chain security.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete. It lacks the required 'Test plan' section with a checklist, and the 'Related' section for linking issues or PRs is missing. Add a 'Test plan' section with a checklist of test scenarios and a 'Related' section to link any relevant issues or pull requests.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'ci: add link-check workflow (lychee)' clearly and concisely summarizes the primary change: adding a new CI workflow for link checking using the lychee tool.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ci/link-check

Comment @coderabbitai help to get the list of available commands and usage tips.

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