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.

Sign up for GitHub

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

Jump to bottom

Add markdown linter in CI #921

Open
mossmaurice opened this issue Sep 7, 2021 · 1 comment · May be fixed by #1890
Open

Add markdown linter in CI #921

mossmaurice opened this issue Sep 7, 2021 · 1 comment · May be fixed by #1890
Labels
tooling All iceoryx related tooling (scripts etc.)

Comments

@mossmaurice
Copy link
Contributor

mossmaurice commented Sep 7, 2021 •
edited

Brief feature description

Markdown files are sometimes not correctly formatted. To ensure a consistent quality the proposal is to have a markdown linter run as GitHub action.

Detailed information

  • No decision made on GitHub or linter tool
  • No preferences on the settings e.g. line length
@mossmaurice mossmaurice added the tooling All iceoryx related tooling (scripts etc.) label Sep 7, 2021
@mossmaurice mossmaurice mentioned this issue Sep 7, 2021
Merged
20 tasks
@dkroenke
Copy link
Member

dkroenke commented Feb 7, 2023

@zmostafa Will work on that ticket.

zmostafa added a commit to zmostafa/iceoryx that referenced this issue Feb 13, 2023
@zmostafa
iox-eclipse-iceoryx#921 Add markdownlint hook and ci script
048fa70 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
@zmostafa zmostafa linked a pull request Feb 13, 2023 that will close this issue
Open
21 tasks
zmostafa added a commit to zmostafa/iceoryx that referenced this issue Feb 13, 2023
@zmostafa
iox-eclipse-iceoryx#921 Add markdownlint hook and ci script
4bb7a91 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
zmostafa added a commit to zmostafa/iceoryx that referenced this issue Feb 13, 2023
@zmostafa
iox-eclipse-iceoryx#921 Remove unrelated names
0c3cb9d 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
zmostafa added a commit to zmostafa/iceoryx that referenced this issue Feb 13, 2023
@zmostafa
iox-eclipse-iceoryx#921 Add markdownlint hook and ci script
ec4217a 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
zmostafa added a commit to zmostafa/iceoryx that referenced this issue May 3, 2023
@zmostafa
iox-eclipse-iceoryx#921 Add markdownlint hook and ci script
403271d 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
zmostafa added a commit to zmostafa/iceoryx that referenced this issue May 3, 2023
@zmostafa
iox-eclipse-iceoryx#921 Enable fixing markdown errors
267ae2d 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
zmostafa added a commit to zmostafa/iceoryx that referenced this issue May 3, 2023
@zmostafa
iox-eclipse-iceoryx#921 Update code line length to match clang's
c55612d 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
zmostafa added a commit to zmostafa/iceoryx that referenced this issue May 3, 2023
@zmostafa
iox-eclipse-iceoryx#921 Run markdownlint for all files
374c367 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
zmostafa added a commit to zmostafa/iceoryx that referenced this issue May 3, 2023
@zmostafa
iox-eclipse-iceoryx#921 Enable markdown in CI
709bea8 
Signed-off-by: Ziad Mostafa <ziad.mostafa@apex.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
tooling All iceoryx related tooling (scripts etc.)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Enable markdownlint in CI and pre-commit hook zmostafa/iceoryx
2 participants
@mossmaurice @dkroenke