Skip to content

Replace Deprecated Link Checker#146

Merged
eprbell merged 11 commits intoeprbell:mainfrom
macanudo527:update_link_checker
Jan 13, 2026
Merged

Replace Deprecated Link Checker#146
eprbell merged 11 commits intoeprbell:mainfrom
macanudo527:update_link_checker

Conversation

@macanudo527
Copy link
Copy Markdown
Collaborator

@macanudo527 macanudo527 commented Jan 4, 2026

The current link checker has been deprecated:

https://github.com/gaurav-nelson/github-action-markdown-link-check

I'm replacing it with Lychee, which appears to be a battle-tested alternative.

I also fixed some mypy errors that came up because of the new version.

I also removed Python 3.8/9 from support since they are EOL.

@macanudo527 macanudo527 self-assigned this Jan 4, 2026
@macanudo527 macanudo527 requested a review from eprbell January 4, 2026 13:23
@macanudo527
Copy link
Copy Markdown
Collaborator Author

@eprbell
This should be pretty straightforward stuff. I just updated it to the latest versions of things. I tried to stick to standard practices.

on: [push, pull_request]
on:
push:
branches: [main]
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Why not leave the check on in branches as well?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Basically, it just cuts down on unnecessary runs. It still runs on PR, but it won't run every single time you push an update. Sometimes when you are in the middle of a PR not everything works, so if you push a commit that doesn't complete the PR you'll get unnecessary warnings.

I mean I don't think it is necessary for every single commit push, do you?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does this stop it from running in your own branch before you open a PR? You certainly want a clean run in your branch before opening the PR.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

It stops it from running every time you push a commit that isn't part of a PR. It's basically just meant to cut down on test runs/reduce minutes used. I don't think we are ever at risk of using all the minutes up on the free plan, but it helps to be efficient. You can also run into issues if you submit multiple commits within a short amount of time, because caching can get corrupted etc... Less runs is generally better if you can get away with it.

As for having a 'dirty' run when you submit a PR, deadlinks aren't mission-critical, just an annoyance that can easily be fixed.

@jayr0d
Copy link
Copy Markdown
Contributor

jayr0d commented Jan 7, 2026

Hmm, just noticed this. I added .markdown-link-check.json in #148 to retry on HTTP 429 to get automated checks to pass. If pull request 146 gets merged I can update my branch and my pull request.

EDIT: We have some other conflicts to resolve, Python version, URLs, type/cast. Python version and URLs is easy for me to clean up second. I don't know the best approach for the type/cast mypy was complaining about. I am indifferent.

Comment thread mypy.ini
@jayr0d
Copy link
Copy Markdown
Contributor

jayr0d commented Jan 12, 2026

Other than on push/pr discussion, looks good to me. I was updating things across the board and we will need another similar pr for DaLI once this gets through.

I am also confused as to when we should be updating .pre-commit-config.yaml

@eprbell eprbell merged commit aaa58d0 into eprbell:main Jan 13, 2026
19 checks passed
jayr0d added a commit to jayr0d/dali-rp2 that referenced this pull request Jan 14, 2026
macanudo527 pushed a commit to eprbell/dali-rp2 that referenced this pull request Feb 12, 2026
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.

3 participants