Skip to content

[DOCS] Add a monthly link check workflow - #1515

Merged
henrydingliu merged 1 commit into
casact:mainfrom
Abhayindia:docs/linkcheck-workflow-1470
Oct 29, 2026
Merged

henrydingliu merged 1 commit into
casact:mainfrom
Abhayindia:docs/linkcheck-workflow-1470

Conversation

@Abhayindia

Copy link
Copy Markdown
Contributor

Fixes #1470.

Adds .github/workflows/linkcheck.yml, adapted from the pandas workflow the issue points to, and .github/lychee.toml for 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.com are 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.

@github-actions

Copy link
Copy Markdown

Pyright Type Completeness

View the full pyright --verifytypes output for this commit

Project (full chainladder package, at this PR's head): 15.8% of exported symbols fully typed (241 / 1524)

Known Ambiguous Unknown Total
Project (head) 241 106 1177 1524

Other symbols referenced but not exported by chainladder: 13

Known Ambiguous Unknown Total
Other (head) 3 1 9 13

Symbols without documentation:

  • Functions without docstring: 340
  • Functions without default param: 0
  • Classes without docstring: 8

Patch (exported symbols added or changed by this PR): no exported symbol type-completeness changes detected.

@codecov

codecov Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.36%. Comparing base (46d6d78) to head (850a605).
⚠️ Report is 1 commits behind head on main.

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           
Flag Coverage Δ
unittests 94.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@henrydingliu

Copy link
Copy Markdown
Member

is this what you mean by job summary?

image

@Abhayindia

Copy link
Copy Markdown
Contributor Author

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).

@henrydingliu
henrydingliu merged commit 6c4538a into casact:main Oct 29, 2026
12 checks passed
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.

[DOC] Add workflow to check broken links

2 participants