search

gaurav-nelson / github-action-markdown-link-check

Check all links in markdown files if they are alive or dead. 🔗✔️
MIT License
399 stars 77 forks source link

Running locally #178

Closed dluc closed 1 year ago

dluc commented 1 year ago

Could you provide some simple instructions about how to run the tool locally on a dev machine (linux/bash possibly), using the exact configuration used by GitHub?

for instance I'm having some false positives and I'm trying to guess the right ignorePattern, polluting a PR with continuous pushes and waiting for GH action to create a report. Obviously this is very time consuming but also creating a lot of noise in pull requests.

Thanks!

PatrickHeneise commented 1 year ago

This is a GitHub Action wrap for https://github.com/tcort/markdown-link-check#markdown-link-check, you'll find all the information there.

gaurav-nelson commented 1 year ago

Thank you @PatrickHeneise

@dluc Note that results wouldn't be exactly same as your local run because the requests IP your machine send is different from GitHub machine and websites handle those requests differently.

Feel free to close this issue if you got your answers.