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

Add GitHub actions to lint markdown files and check links #169

Merged
merged 25 commits into from
Apr 21, 2021

Conversation

MakisH
Copy link
Member

@MakisH MakisH commented Apr 17, 2021

This adds:

  • the markdownlint action to the "Check" workflow, to check all of our markdown files for common violations.
  • the markdown-link-check action to check all the links in markdown files. Since this checks too many links on GitHub, it often replies with 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.

@MakisH MakisH self-assigned this Apr 17, 2021
@MakisH MakisH changed the title Add GitHub action to lint markdown files Add GitHub action to lint markdown files and check links Apr 21, 2021
@MakisH MakisH changed the title Add GitHub action to lint markdown files and check links Add GitHub actions to lint markdown files and check links Apr 21, 2021
@MakisH MakisH marked this pull request as ready for review April 21, 2021 08:38
@MakisH
Copy link
Member Author

MakisH commented Apr 21, 2021

@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.

@MakisH MakisH requested a review from davidscn April 21, 2021 08:56
Copy link
Member

@davidscn davidscn left a 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?

@MakisH
Copy link
Member Author

MakisH commented Apr 21, 2021

markdown files look cleaner +1
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 CONTRIBUTING.md.

@MakisH MakisH requested a review from davidscn April 21, 2021 12:44
@MakisH MakisH merged commit 423b76b into develop Apr 21, 2021
@MakisH MakisH deleted the actions-markdownlint branch April 21, 2021 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants