Skip to content

Conversation

@pp-mo
Copy link
Member

@pp-mo pp-mo commented Mar 27, 2025

Replaces the nox-based, per-PR link check with an occasional scheduled (or manually triggered) linkcheck.

This is based on "lychee", which can check the RSTs directly

Pros:

  • doesn't require the docs build
  • independent of Sphinx
  • really simple to configure
  • the resulting workflow should port unchanged to other repos (so ripe for templating)
  • already supports a manually triggered action, as well as time-triggered
  • produces a nicely formatting check summary, which also appears on the action
  • produces a repo Issue, including the summary, only if there were any link failures

Cons:

  • doesn't check our links written as Sphinx roles, i.e. :pep:, :PR:, and :Issue:, as seen (mostly) in whatsnews.
  • doesn't provide source-line references for failing urls

Copy link
Contributor

@scitools-ci scitools-ci bot left a comment

Choose a reason for hiding this comment

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

Please see SciTools/.github#62

Copy link
Contributor

@scitools-ci scitools-ci bot left a comment

Choose a reason for hiding this comment

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

Please see SciTools/.github#63

Copy link
Contributor

@scitools-ci scitools-ci bot left a comment

Choose a reason for hiding this comment

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

Please see SciTools/.github#64

@codecov
Copy link

codecov bot commented Mar 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.80%. Comparing base (2605673) to head (94f54f3).
Report is 74 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6386   +/-   ##
=======================================
  Coverage   89.80%   89.80%           
=======================================
  Files          90       90           
  Lines       23752    23752           
  Branches     4418     4418           
=======================================
  Hits        21331    21331           
  Misses       1672     1672           
  Partials      749      749           

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

@pp-mo pp-mo changed the title Linkcheck Make regular linkcheck, not on PRs Mar 27, 2025
@pp-mo pp-mo changed the title Make regular linkcheck, not on PRs Run linkcheck regularly, instead of on PRs Mar 27, 2025
@pp-mo pp-mo changed the title Run linkcheck regularly, instead of on PRs Run linkchecks regularly, instead of on PRs Mar 27, 2025
Copy link
Contributor

@scitools-ci scitools-ci bot left a comment

Choose a reason for hiding this comment

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

Please see SciTools/.github#65

Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

A few changes for you, and one possible show-stopper.

scitools-ci[bot]
scitools-ci bot previously requested changes Mar 28, 2025
Copy link
Contributor

@scitools-ci scitools-ci bot left a comment

Choose a reason for hiding this comment

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

Please see SciTools/.github#66

@pp-mo pp-mo linked an issue Mar 28, 2025 that may be closed by this pull request
@trexfeathers
Copy link
Contributor

Super, thanks for this exciting improvement @pp-mo!

@trexfeathers trexfeathers dismissed scitools-ci[bot]’s stale review March 28, 2025 12:06

I consider the requested scitools-ci actions to be completed, except for SciTools/.github#65, which we will keep open until we have a MANIFEST.in template - planned for the future.

@trexfeathers trexfeathers merged commit 6928d4b into SciTools:main Mar 28, 2025
21 checks passed
@scitools-ci scitools-ci bot removed this from 🚴 Peloton Apr 26, 2025
trexfeathers added a commit to trexfeathers/iris that referenced this pull request Apr 30, 2025
* Add lychee-based linkcheck workflow.

* Remove old nox-based per-PR linkcheck.

* Remove nox-linkcheck from python-version-checks test.

* Configure manifest to exclude the linkcheck ignores file.

* Update .github/workflows/ci-linkchecks.yml

Co-authored-by: Martin Yeo <[email protected]>

* Update .github/workflows/ci-linkchecks.yml

Co-authored-by: Martin Yeo <[email protected]>

* Add links badge to README.

* Test urls in all files python, exclude or replace failing urls in python.

* Run checks every day, including weekends.

* Apply Iris-friendly labels to linkcheck failure Issues.

---------

Co-authored-by: Martin Yeo <[email protected]>
@pp-mo pp-mo deleted the linkcheck branch November 29, 2025 11:38
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.

Link Checking Procedure

2 participants