Enable markdownlint in CI and pre-commit hook

[zmostafa]

Signed-off-by: Ziad Mostafa [email protected]

Pre-Review Checklist for the PR Author

1. Code follows the coding style of CONTRIBUTING.md
2. Tests follow the best practice for testing
3. Changelog updated in the unreleased section including API breaking changes
4. Branch follows the naming format (iox-123-this-is-a-branch)
5. Commits messages are according to this guideline
   • Commit messages have the issue ID (iox-#123 commit text)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
6. Update the PR title
   • Follow the same conventions as for commit messages
   • Link to the relevant issue
7. Relevant issues are linked
8. Add sensible notes for the reviewer
9. All checks have passed (except task-list-completed)
10. All touched (C/C++) source code files from iceoryx_hoofs are added to ./clang-tidy-diff-scans.txt
11. Assign PR to reviewer

Notes for Reviewer

Checklist for the PR Reviewer

• Commits are properly organized and messages are according to the guideline
• Code according to our coding style and naming conventions
• Unit tests have been written for new behavior
• Public API changes are documented via doxygen
• Copyright owner are updated in the changed files
• All touched (C/C++) source code files from iceoryx_hoofs have been added to ./clang-tidy-diff-scans.txt
• PR title describes the changes

Post-review Checklist for the PR Author

1. All open points are addressed and tracked via issues

References

• Closes Add markdown linter in CI #921

[zmostafa]

@mossmaurice @dkroenke Just a first commit for enabling the markdownlint tool in pre-commit and also add it to the docker image,did not enable the check now.

Next steps:

• Force fixing the errors found by the linter using --fix flag
• Analyze the error log and break the build when errors are still there.

Am I still missing something ?

[mossmaurice]

Thanks for the PR @zmostafa, much appreciated.

Next steps:

• Force fixing the errors found by the linter using --fix flag
• Analyze the error log and break the build when errors are still there.

I think it would be good to right away fix the files here on this PR.

Am I still missing something?

What we should do is to try if it affects the MkDocs build via tools/website/export-docu-to-website.sh local. I think it won't have an effect. Anyway, IIRC the MkDocs build is currently broken, but we should evaluate the output without the linter changes on this PR and with these changes.

cc @dkroenke

[mossmaurice]

@zmostafa What do you think about setting the values to 120 like for the code via clang-format?

[mossmaurice]

I think it's good to run the linter on all markdown files.

@elfenpiff What do you think?

[elfenpiff]

Yes, it is actually very important!

Just think file A links to file B and one moves file B. Then the link of file A is broken but this will be never detected since only the modified files are checked and A was never modified.

[codecov]

Codecov Report

Merging #1890 (374c367) into master (90996dc) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 374c367 differs from pull request most recent head 709bea8. Consider uploading reports for the commit 709bea8 to get more accurate results

@@            Coverage Diff             @@
##           master    #1890      +/-   ##
==========================================
- Coverage   74.05%   74.05%   -0.01%     
==========================================
  Files         404      404              
  Lines       15924    15924              
  Branches     2243     2243              
==========================================
- Hits        11793    11792       -1     
  Misses       3422     3422              
- Partials      709      710       +1     

Flag	Coverage Δ
unittests	73.72% <ø> (-0.01%)	⬇️
unittests_timing	14.73% <ø> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

[elBoberido]

@zmostafa are you planing to continue working on this PR?

[zmostafa]

@mossmaurice Do we still need the markdown linter? We concluded that we can postpone this since we also postponed the release.

cc. @elBoberido

[mossmaurice]

@mossmaurice Do we still need the markdown linter? We concluded that we can postpone this since we also postponed the release.

@zmostafa Yes, the markdown linter would be much appreciated. As we decided to postpone the 3.0 release until new user- experienceable features will be added, this does not have a super high prio.

[elBoberido]

@mossmaurice @zmostafa okay, it has not high priority but it also does not mean one can not work any time on this. I just wanted to be sure this PR does not stay open forever without the intention to continue to work on it. Take you time an finish it comfortably.