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

Housekeeping: Markdownlint #905

Merged
merged 19 commits into from
Feb 24, 2023
Merged

Housekeeping: Markdownlint #905

merged 19 commits into from
Feb 24, 2023

Conversation

lovromazgon
Copy link
Member

@lovromazgon lovromazgon commented Feb 23, 2023

Description

Adds the CI action https://github.com/DavidAnson/markdownlint-cli2-action that executes https://github.com/DavidAnson/markdownlint when markdown files are updated. Settings are stored in .markdownlint.yml and taken mostly from here with some changes (i.e. line length 120, tables excluded from line length checks, hard tabs are allowed in go code blocks, Conduit needs to be written with an uppercase C).

The CI action lints all markdown files (i.e. files that end with .md) except LICENSE.md, anything in pkg/web/openapi, anything in ui/node_modules and markdown files in .github.

I also ran markdown-cli2-fix that fixed most of the issues, the rest were fixed manually.

Quick checks:

  • I have followed the Code Guidelines.
  • There is no other pull request for the same update/change.
  • I have written unit tests.
  • I have made sure that the PR is of reasonable size and can be easily reviewed.

@lovromazgon lovromazgon requested a review from a team February 23, 2023 13:37
@lovromazgon lovromazgon requested a review from a team as a code owner February 23, 2023 13:37
@lovromazgon lovromazgon marked this pull request as draft February 23, 2023 13:39
@lovromazgon lovromazgon marked this pull request as ready for review February 23, 2023 14:38
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 23, 2023
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 23, 2023
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 23, 2023
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 23, 2023
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 23, 2023
@github-actions
Copy link
Contributor

UI test coverage: 79.31%

🤷‍♂️ Did not change

@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 23, 2023
Copy link
Contributor

@jayjayjpg jayjayjpg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads great, thank you for adding this useful tool to the CI workflow and updating the repo docs so quickly! ✨

docs/code_guidelines.md Outdated Show resolved Hide resolved
Copy link
Contributor

@maha-hajja maha-hajja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lovely work! and super useful :D

.github/workflows/markdown-lint.yml Show resolved Hide resolved
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 24, 2023
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 24, 2023
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 24, 2023
@ConduitIO ConduitIO deleted a comment from github-actions bot Feb 24, 2023
@lovromazgon lovromazgon merged commit cd45646 into main Feb 24, 2023
@lovromazgon lovromazgon deleted the lovro/markdownlint branch February 24, 2023 17:17
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