Run link checker on Markdown files #1291
Open
Conversation
This file contains hidden or 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
gpeb2
added
documentation
gpeb2
requested changes
Oct 7, 2024
There was a problem hiding this comment.
Thank you for this contribution and apologies for not reviewing it sooner.
Whilst this pull request currently adds the Markdown link checker GitHub action, as suggested in the issue, merging this as it is will block any future pull requests until all of the broken links that the action finds are fixed.
To get a list of the broken links it is possible to run the action locally using the act tool. Fixing them then requires either putting in an exclusion pattern/rule (i.e. for example URLs), or finding the new/correct link and replacing it.
…esolves cambridge-cares#464 Fix existing broken links
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config * add on merge fix --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config * add on merge fix * finish link fixes * finish link fixes --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config * add on merge fix * finish link fixes * finish link fixes --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config * add on merge fix * finish link fixes * finish link fixes * rename workflow --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config * add on merge fix * finish link fixes * finish link fixes * rename workflow * test --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config * add on merge fix * finish link fixes * finish link fixes * rename workflow * test * undo test --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config * add on merge fix * finish link fixes * finish link fixes * rename workflow * test * undo test * fix links --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
* dev-markdown-link-check: add github workflow to check markdown links. Resolves cambridge-cares#464 * fix markdown links * fix broken links * fix readmes * fix links * fix broken links and configure github action * add on merge for modified files * fix config * add on merge fix * finish link fixes * finish link fixes * rename workflow * test * undo test * fix links * fix config --------- Co-authored-by: Myles MacDonald <mylesmacdonald@Myless-Mac-mini.local>
mayomatsuda
commented
Apr 14, 2025
| @@ -0,0 +1,65 @@ | |||
| { | |||
| "ignorePatterns": [ | |||
There was a problem hiding this comment.
certain links prevent the workflow from working even though they're fine, e.g. dropbox. I've added such to this list. The workflow is buggy with header references (#) and mailto so ignoring those as well.
and ignoring /user, /explore and /images/defaults because it's part of the website code
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.
Add github workflow to check markdown links for broken links before pushing.
Resolves #464