Comments (6)
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.
from helm-charts.
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.
from helm-charts.
Sounds like someone wants to write a GH Action ๐ (I can relate! They're super-fun)
One note: @Xtigyro mentioned the markdownlint
vscode plugin for local work: https://github.com/DavidAnson/vscode-markdownlint (can also be run apart from vscode https://github.com/DavidAnson/markdownlint).
from helm-charts.
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 :-)
from helm-charts.
Yeah - I think that's fine. I like superlinter!
I'm also not in favour of pre-commit hooks - my arguments are exactly the same as stated by @scottrigby above.
from helm-charts.
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.
from helm-charts.
Related Issues (20)
- [prometheus] Allow User to Configure ConfigMap Metadata Annotation HOT 2
- [kube-prometheus-stack] Regex error for appNamespacesTarget:
- [prometheus-blackbox-exporter] define field port in selfservicemonitor
- [kube-prometheus-stack] PV and PVC for prometheus and grafana
- [kube-prometheus-stack] Installation problems HOT 2
- [kube-prometheus-stack] grafana: Readiness probe failed: connect: connection refused HOT 2
- [kube-prometheus-stack] windows-exporter deprecated flags
- [kube-prometheus-stack] kubernetes-mixin dashboards links do not work anymore HOT 9
- [prometheus-pushgateway] pod prometheus-pushgateway label not match NOTES display post install HOT 1
- [kube-prometheus-stack] Prometheus not created if additionalArgs are set HOT 6
- [kube-prometheus-stack] built in grafana dashboards invalid
- [prometheus-promlens] Can we have community helm chart for promlens
- [kube-prometheus-stack] Ingress Annotation templating breaks valid annotations HOT 1
- [kube-prometheus-stack] grafana dashboards set as home dashboard in values.yaml HOT 1
- [kube-prometheus-stack] grafana dashboards contain hardcoded "-- Grafana --" string
- [kube-prometheus-stack] Event trigger but not received HOT 4
- [prometheus-kube-stack] Pick up latest Grafana chart (>=7.3.1) as it contains the fix for CVE-2023-6152 HOT 1
- [kube-prometheus-stack] unique labels for default prometheusrule
- [prometheus-postgres-exporter] http2=false address=[::]:9187 HOT 3
- [kube-prometheus-stack] Grafana chart version 7.3.2 breaks k8s-sidecar HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from helm-charts.