DC-5259 Added Lychee Link Checker #7192
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
WalkthroughAdds a GitHub Actions workflow (.github/workflows/lychee.yml) that runs on pull_request to run lycheeverse/lychee-action@v2, fails on link errors, and on failure creates an issue from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
Comment |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
Deploying docs with
|
| Latest commit: |
d1c5be6
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a9f72b1a.docs-51g.pages.dev |
| Branch Preview URL: | https://dc-5259-lychee-link-checker.docs-51g.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/workflows/lychee.yml (1)
2-2: Consider adding manual and scheduled triggers.Add
workflow_dispatchand a weeklyscheduleto catch rot outside PRs.-on: [pull_request] +on: + pull_request: + workflow_dispatch: + schedule: + - cron: '0 6 * * 1' # Mondays 06:00 UTC
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/lychee.yml(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Check internal links
- GitHub Check: runner / linkspector
- GitHub Check: Cloudflare Pages
.github/workflows/lychee.yml
Outdated
Comment on lines
12
to
24
| - name: Link Checker | ||
| id: lychee | ||
| uses: lycheeverse/lychee-action@v2 | ||
| with: | ||
| fail: true | ||
|
|
||
| - name: Create Issue From File | ||
| if: steps.lychee.outputs.exit_code != 0 | ||
| uses: peter-evans/create-issue-from-file@v5 | ||
| with: | ||
| title: Link Checker Report | ||
| content-filepath: ./lychee/out.md | ||
| labels: report, automated issue |
There was a problem hiding this comment.
Create-issue step will never run; missing lychee output file. Fix failure flow and configure output.
fail: truecauses the job to stop on Line 14; the “Create Issue From File” step won’t run../lychee/out.mdis never produced; nooutput/formatconfigured for the action.- Step condition should use expression syntax; also guard for forked PRs to avoid permission failures.
Apply this diff to make the report creation reliable and still fail the job:
- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@v2
+ continue-on-error: true
with:
- fail: true
+ # Let the workflow control failure after creating the issue
+ fail: false
+ # Use the token to improve rate limits (e.g. GitHub links)
+ token: ${{ secrets.GITHUB_TOKEN }}
+ # Produce a markdown report file for the next step
+ format: markdown
+ output: ./lychee/out.md
+
+ - name: Ensure report directory exists
+ run: mkdir -p lychee
- name: Create Issue From File
- if: steps.lychee.outputs.exit_code != 0
+ if: ${{ steps.lychee.outputs.exit_code != 0 && github.event.pull_request.head.repo.fork == false }}
uses: peter-evans/create-issue-from-file@v5
with:
title: Link Checker Report
content-filepath: ./lychee/out.md
labels: report, automated issue
+
+ - name: Fail workflow if broken links found
+ if: ${{ steps.lychee.outputs.exit_code != 0 }}
+ run: exit 1This preserves PR failure on bad links, creates the issue when possible, and avoids write attempts from forked PRs.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - name: Link Checker | |
| id: lychee | |
| uses: lycheeverse/lychee-action@v2 | |
| with: | |
| fail: true | |
| - name: Create Issue From File | |
| if: steps.lychee.outputs.exit_code != 0 | |
| uses: peter-evans/create-issue-from-file@v5 | |
| with: | |
| title: Link Checker Report | |
| content-filepath: ./lychee/out.md | |
| labels: report, automated issue | |
| - name: Link Checker | |
| id: lychee | |
| uses: lycheeverse/lychee-action@v2 | |
| continue-on-error: true | |
| with: | |
| # Let the workflow control failure after creating the issue | |
| fail: false | |
| # Use the token to improve rate limits (e.g. GitHub links) | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| # Produce a markdown report file for the next step | |
| format: markdown | |
| output: ./lychee/out.md | |
| - name: Ensure report directory exists | |
| run: mkdir -p lychee | |
| - name: Create Issue From File | |
| if: ${{ steps.lychee.outputs.exit_code != 0 && github.event.pull_request.head.repo.fork == false }} | |
| uses: peter-evans/create-issue-from-file@v5 | |
| with: | |
| title: Link Checker Report | |
| content-filepath: ./lychee/out.md | |
| labels: report, automated issue | |
| - name: Fail workflow if broken links found | |
| if: ${{ steps.lychee.outputs.exit_code != 0 }} | |
| run: exit 1 |
🤖 Prompt for AI Agents
.github/workflows/lychee.yml lines 12-24: the lychee action is currently
configured with fail: true so the job stops and the "Create Issue From File"
step never runs, and no output file is configured; change lychee to run
non-fatal (set fail: false) and configure its output format/file (e.g., format:
md and output: ./lychee/out.md) so the action produces ./lychee/out.md and
exposes an exit_code output, update the Create Issue step to use the expression
syntax for the condition (if: steps.lychee.outputs.exit_code != '0') and
additionally guard against runs from forked PRs by checking the repo identity
(e.g., if: steps.lychee.outputs.exit_code != '0' &&
github.event.pull_request.head.repo.full_name == github.repository) so it won't
attempt to write from forks, and finally add a short step after to fail the job
when exit_code != '0' (run: exit 1 with the same guarded if) so the workflow
still fails on bad links while allowing report creation when permitted.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit