[CI] Add lychee link checker workflow - #12931
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #12931 +/- ##
============================================
- Coverage 18.02% 18.02% -0.01%
- Complexity 16464 16465 +1
============================================
Files 5973 5973
Lines 537466 537466
Branches 65991 65991
============================================
- Hits 96853 96852 -1
- Misses 429690 429691 +1
Partials 10923 10923
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
This PR is stale because it has been open for 120 days with no activity. It may be removed by administrators of this project at any time. Remove the stale label or comment to request for removal of it to prevent this. |
DaanHoogland
left a comment
There was a problem hiding this comment.
clgtm. we may want to revisit the excludes soon.
| uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0 | ||
| with: | ||
| args: --config lychee.toml . | ||
| fail: false |
There was a problem hiding this comment.
fail: false here, and the report step only runs on schedule. So on a PR this always goes green and prints nothing. Is that intended, or should PRs surface the broken links somewhere?
| persist-credentials: false | ||
| - name: Link Checker | ||
| id: lychee | ||
| uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0 |
There was a problem hiding this comment.
No GITHUB_TOKEN in the env, so github.com links get rate limited and come back looking broken. Worth adding?
| permissions: | ||
| issues: write # required for Broken Links Report | ||
| steps: | ||
| - uses: actions/checkout@v6 |
There was a problem hiding this comment.
Every other workflow here pins actions by SHA. Pin this one and github-script below to match?
| // Ensure the path is correct relative to the workspace root | ||
| const reportBody = fs.readFileSync('./lychee/out.md', 'utf8'); | ||
|
|
||
| await github.rest.issues.create({ |
There was a problem hiding this comment.
This opens a new issue every Sunday. Should it update an existing open one instead?
| "https://downloads.chef.io/chef-dk/", | ||
| "https://github.com/YOUR_ACCOUNT/cloudstack", | ||
| "https://iconka.com/en/downloads/cat-power/", | ||
| "https://issues.apache.org/.*", |
There was a problem hiding this comment.
This skips every Jira link in the repo. Can we narrow it once we see what actually breaks?
Description
This PR...
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
How Has This Been Tested?
How did you try to break this feature and the system with this change?