Enable markdownlint in CI and pre-commit hook

[zmostafa]

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

Pre-Review Checklist for the PR Author

1. [x] Code follows the coding style of CONTRIBUTING.md
2. [x] Tests follow the best practice for testing
3. [ ] Changelog updated in the unreleased section including API breaking changes
4. [x] 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. [x] Update the PR title
   • Follow the same conventions as for commit messages
   • Link to the relevant issue
7. [x] 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. [x] Assign PR to reviewer

Notes for Reviewer

Checklist for the PR Reviewer

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

Post-review Checklist for the PR Author

1. [ ] All open points are addressed and tracked via issues

References

• Closes #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 ?

[codecov[bot]]

Codecov Report

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

:exclamation: 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%)	:arrow_down:
unittests_timing	14.73% <ø> (-0.02%)	:arrow_down:

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.