-
-
Notifications
You must be signed in to change notification settings - Fork 82
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
Add GitHub actions to lint markdown files and check links #169
Conversation
@davidscn this is finally ready for review! Do you see anything strange in the diff? Do you like the new actions? Please don't merge just yet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
markdown files look cleaner 👍
Only comment from my side: we need some instructions how to run this checks locally. Otherwise, one gets the errors when committing (:wink: ). Is there a related ubuntu package?
Very good point, I documented this in |
This adds:
429 too many requests
. As this mainly concerns issues and pull requests that are not expected to disappear, I consider these links as alive.This also fixes the currently detected violations and replaces all relative links to precice.org with static links (to the non-www version).
Additional motivation: this could find wrongly-nested lists, wrong heading levels, ... Things that are easy to miss visually. Besides, this also checks links and I already found a bad one. Moreover, this tries to enforce a bit more general markdown rules. GitHub allows a few differences (e.g. no empty lines before lists), which means that other tools (e.g. pandoc) could have trouble with out files in the future.