Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] - feat(CI): add Markdown link checker #1037

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jbampton
Copy link
Contributor

@jbampton jbampton commented Dec 16, 2020

  • Checks for dead links in Markdown files
  • First run will check all files and then we will have a list of dead links
  • Then we can set it up to only run on files added in the PR
  • Fix links
  • Fix Markdown heading

@jbampton jbampton force-pushed the add-markdown-link-checker branch 4 times, most recently from 1c64506 to eee98b7 Compare December 16, 2020 14:51
@zspitzer
Copy link
Member

can we set this up to run as a separate action, rather than on every PR?

is there a verbosity filter, we only need to see problems, not the result of every file without problems

@jbampton jbampton force-pushed the add-markdown-link-checker branch 2 times, most recently from 798963a to 299fce5 Compare December 16, 2020 15:34
@jbampton
Copy link
Contributor Author

jbampton commented Dec 16, 2020

Hey @zspitzer you can read about it here -> https://github.com/gaurav-nelson/github-action-markdown-link-check

There is a setting check-modified-files-only to only check files in the PR so it will be a lot quicker.

This first run will just collect the broken links.

Looks like we are being rate limited by GitHub as it's saying all github.com links are broken.

Also you can see the config file settings here -> https://github.com/tcort/markdown-link-check#config-file-format

@jbampton
Copy link
Contributor Author

@jbampton jbampton force-pushed the add-markdown-link-checker branch 4 times, most recently from b8240f1 to 63c5ba4 Compare December 17, 2020 03:39
- Checks for dead links in Markdown files
- First run will check all files and then we will have a list of dead links
- Then we can set it up to only run on files added in the PR
- Fix links
- Fix Markdown heading
@jbampton jbampton changed the title feat(CI): add Markdown link checker [WIP] - feat(CI): add Markdown link checker Feb 14, 2021
@jbampton jbampton marked this pull request as draft May 12, 2021 04:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants