Repository navigation
ci: use markdown-link-check action in tests workflow - #499
Conversation
|
| args: ["-q", "-c", ".markdown_link_config.json"] | ||
| stages: [manual] | ||
|
|
||
| - repo: https://github.com/astral-sh/ruff-pre-commit |
There was a problem hiding this comment.
Local link-check instructions are stale
CONTRIBUTING.md still tells contributors that just lint-all runs markdown-link-check, but this removes that hook. The command no longer checks links locally. Update the contributor instructions and the comment above lint-all in justfile to explain that link checks now run in CI.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #499 +/- ##
=======================================
Coverage 93.56% 93.56%
=======================================
Files 51 51
Lines 2982 2982
Branches 414 414
=======================================
Hits 2790 2790
Misses 129 129
Partials 63 63 🚀 New features to boost your workflow:
|
References
Description
Replaces the manual-stage
markdown-link-checkpre-commit hook with the reusablecalysto/maintainer_tools/actions/markdown-link-check@v1action, run as a dedicated job in the tests workflow.Changes
markdown_link_checkjob to.github/workflows/tests.ymlusingcalysto/maintainer_tools/actions/markdown-link-check@v1, and add it totests_check.needs.tcort/markdown-link-checkpre-commit hook..markdown_link_config.json; the action's bundled defaults cover the previous settings. The generatedmetakernel/magics/README.md(which contains fake example URLs from magic docstrings) is skipped via the action'signore-pathsinput.Backwards-incompatible changes
None
Testing
actionlintpasses on the modified workflow.markdown-link-checklocally against the whole repo using the action's default config plus the newignore-pathsvalue; exit 0.AI usage