Lightweight workflow to check for broken markdown links #1271
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carmocca
reviewed
Apr 11, 2024
|
Thanks. I updated it and it works, returning a non-zero exit code when failing one of the link checks. This is ready to be merged now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since certain people (looking at me!) have a tendency to insert broken markdown links, I think it might be a good idea to check for this as part of the linter.
So, I added a lightweight workflow.
Caveat: It works reliably, but I am not sure how I get it to error if it detects broken links. One has to manually check the report right now. It would be nicer if we could get it to error out if it fails on a link.