Repository navigation
[DOCS] Add a monthly link check workflow - #1515
Conversation
Pyright Type CompletenessView the full Project (full
Other symbols referenced but not exported by
Symbols without documentation:
Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1515 +/- ##
=======================================
Coverage 94.36% 94.36%
=======================================
Files 97 97
Lines 6188 6188
Branches 798 798
=======================================
Hits 5839 5839
Misses 225 225
Partials 124 124
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:
|
|
No, that is the log of the Check links step. The job summary is the rendered report on the run's Summary page: https://github.com/casact/chainladder-python/actions/runs/40830935672#summary-123304745302 (735 links checked, 24 errors, and the job still passes). |

Fixes #1470.
Adds
.github/workflows/linkcheck.yml, adapted from the pandas workflow the issue points to, and.github/lychee.tomlfor it. It runs lychee over the repository on the 1st of each month at 03:00 UTC, on manual dispatch, and on pull requests that change either of the two files.Broken links are listed in the job summary and never fail the job; it only fails if lychee itself errors (exit code other than 0 or 2). Links to
github.comare checked without their#fragment, since those anchors are often added by JavaScript, and 403 and 429 are accepted because bot-blocking hosts return them. Unlike the pandas version it does not open or update an issue; I asked on #1470 whether you want that and can add it.I could not run lychee locally, so the config is untested against this repository's content. The workflow runs on this pull request because it changes the workflow file, which will show what the first report looks like, and I expect to tune the excludes from it. The two actions are pinned to full commit SHAs, as in #1497.