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
Consider Adding a Mark Down Linter GitHub Action #19
Comments
Cool idea. Someone may want to play with these in a PR: https://github.com/marketplace?type=actions&query=markdownlint I would recommend a separate GitHub Actions workflow for this. |
Would be nice if one could execute the same linter locally. I personally like https://pre-commit.com/ as it allows to lint only modified files. |
Sounds like someone wants to write a GH Action 😉 (I can relate! They're super-fun) One note: @Xtigyro mentioned the |
I added two draft PRs to demonstrate two different approaches. One is using pre-commit and the other one super-linter. No matter for which we decide we should fix lint errors on all files to improve contributor experience. For example super-linter just checks modified files, which is the reason why everything is ok. It would be bad if we force the first contributor modifying a file to fix all linting errors. PS: Sorry for the not so well created PRs. It's just terrible trying to author something on a mobile :-) |
I agree pre-commit hook approach has the downside of burdening each new user with every previous problem. I find that better for internal teams than projects where we want to encourage many contributors. superlinter looks pretty cool! Calls https://github.com/igorshubovych/markdownlint-cli#readme which calls https://github.com/DavidAnson/markdownlint anyway… nice 😄 I leave it to the maintainers to decide, but I see nothing wrong in this approach personally from a charts repo CI perspective. |
Yeah - I think that's fine. I like superlinter! |
* update install instructions Signed-off-by: Jackline Mutua <jmutua@vmware.com> * fix typo on cosigned readme Signed-off-by: Jackline Mutua <jmutua@vmware.com> * update signed example case Signed-off-by: Jackline Mutua <jmutua@vmware.com> * update chart version Signed-off-by: Jackline Mutua <jmutua@vmware.com> * update chart version Signed-off-by: Jackline Mutua <jmutua@vmware.com> * update chart version Signed-off-by: Jackline Mutua <jmutua@vmware.com>
Add VTL Lab chart
[kube-prometheus-stack] add ks-prometheus project and sync recording rules.
As a follow-up of our discussion (me and @scottrigby) - it should be beneficial to add a GitHub Action that does Mark Down linting.
The text was updated successfully, but these errors were encountered: