Skip to content

ci: Use lychee for linkchecking#2676

Merged
matthewfeickert merged 1 commit intomainfrom
feat/lychee
Mar 17, 2026
Merged

ci: Use lychee for linkchecking#2676
matthewfeickert merged 1 commit intomainfrom
feat/lychee

Conversation

@kratsg
Copy link
Copy Markdown
Contributor

@kratsg kratsg commented Mar 17, 2026

Pull Request Description

As requested in #2675 - trying out lychee instead for linkchecking.

  • Use lychee for more robust linkchecking than Sphinx's linkcheck

pyhf/docs/Makefile

Lines 197 to 202 in 26962f5

.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Use lychee for more robust linkchecking than Sphnix's linkcheck.
   - Use https://github.com/lycheeverse/lychee-action over local install.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.24%. Comparing base (26962f5) to head (ece766c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2676   +/-   ##
=======================================
  Coverage   98.24%   98.24%           
=======================================
  Files          65       65           
  Lines        4220     4220           
  Branches      464      464           
=======================================
  Hits         4146     4146           
  Misses         45       45           
  Partials       29       29           
Flag Coverage Δ
contrib 98.12% <ø> (ø)
doctest 98.24% <ø> (ø)
unittests-3.10 96.44% <ø> (ø)
unittests-3.11 96.44% <ø> (ø)
unittests-3.12 96.44% <ø> (ø)
unittests-3.13 96.44% <ø> (ø)
unittests-3.9 96.49% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 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.

@matthewfeickert matthewfeickert added CI CI systems, GitHub Actions docs Documentation related labels Mar 17, 2026
@github-project-automation github-project-automation bot moved this to In progress in pyhf v0.8.0 Mar 17, 2026
Copy link
Copy Markdown
Member

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good — thanks @kratsg! — but I'm confused what is going on with Codecov. :? How can changing how the linkchecks work affect the coverage? https://app.codecov.io/gh/scikit-hep/pyhf/pull/2676/indirect-changes

Image

That doesn't make sense.

@matthewfeickert matthewfeickert changed the title chore: use lychee for linkchecking CI: Use lychee for linkchecking Mar 17, 2026
@matthewfeickert matthewfeickert changed the title CI: Use lychee for linkchecking ci: Use lychee for linkchecking Mar 17, 2026
Copy link
Copy Markdown
Member

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, now it is passing. Weird. :? We might need to figure out if there's something up with how Codecov reports are getting uploaded.

@matthewfeickert matthewfeickert merged commit 886e262 into main Mar 17, 2026
25 of 26 checks passed
@matthewfeickert matthewfeickert deleted the feat/lychee branch March 17, 2026 04:27
@github-project-automation github-project-automation bot moved this from In progress to Done in pyhf v0.8.0 Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI CI systems, GitHub Actions docs Documentation related

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants