Repository navigation
Add run-link-check label & CI to run link-check in PRs #1676
Description
It would be helpful to have a run-link-check label which can be added to PRs, similarly to how the run-benchmark label works, to ensure link-check succeeds without needing to find workarounds to actually get the link-check to test to run.
Recent examples of where this would have helped to save time:
- Nightly CI builds failing - Link Changes #1675 where I believe the workaround of "manually run jobs through the Actions tab" was used for each commit in order to debug link-check issues.
- Add algorithm-level citations for spherical geometry implementations #1635 added many new links and was merged to
mainwithout ever running link-check, which led to broken links that needed to be debugged as part of 1675 (but not as the originally-noticed main cause of 1675). - Fix uxarray CI link-check failure #1584 where the workaround of "temporarily comment out the restriction to not run link-check on PRs" was used in order to debug link-check issues.
Perhaps a corresponding checklist item should also be added to the default PR form under the "Documentation" section, something like:
- [ ] If this PR updated any links in any `.rst` files, ran `link-check` to test for broken links.
<!-- Adding the run-link-check label (if your uxarray repo permissions allow it) will run link-check
If you need link-check to be run but don't have permissions, leave this item unchecked for now. -->
Activity
erogluorhan commentedon Aug 14, 2026
I agree this would be helpful (though personally I don't see
workflow_dispatch, i.e. Actions -> CI -> Run workflow -> on PR's branch, as a workaround, it is just another GitHub mechanism.I don't prefer to add a PR checklist item for this though because I think even the existing checklist might feel a little overwhelming with several sections and checkboxes to be clicked. I'd rather advocate for making the current one more concise.
Sevans711 commentedon Aug 24, 2026
(Linking here for future reference, regarding more concise PR form: #1696, #1703)