Merge pull request #3 from Piwero/piwero/yaml-linters-setup

Repo setup

.github/workflows/markdown-linter.yml

@@ -21,7 +21,7 @@ jobs:
       contents: read
     steps:
       - name: Install mardownlint
-        run: npm install -g markdownlint-cli@0.33.0
+        run: npm install -g markdownlint-cli@0.39.0
       - name: Checkout project
         uses: actions/checkout@cd7d8d697e10461458bc61a30d094dc601a8b017
       - name: Execute markdownlint

.markdownlint.json

@@ -0,0 +1,7 @@
+{
+   "default": true,
+   "MD013": false,
+   "MD029": { "style": "ordered" },
+   "MD033": false,
+   "MD047": false
+ }

.markdownlintignore

@@ -0,0 +1 @@
+LICENSE.md

.pre-commit-config.yaml

@@ -4,7 +4,13 @@ repos:
   hooks:
   - id: check-yaml
     args: [--allow-multiple-documents]
+
 - repo: https://github.com/gruntwork-io/pre-commit
   rev: v0.0.9
   hooks:
-  - id: helmlint
+  - id: helmlint
+
+- repo: https://github.com/igorshubovych/markdownlint-cli
+  rev: v0.39.0
+  hooks:
+  - id: markdownlint

README.md

@@ -1,10 +1,11 @@
 # PiwHelm
+
 Reusable Helm template chart to deploy different K8s objects like deployments, configmaps, secrets, ingress ...
 
-# TL;DR
-...
+## TL;DR
+
+## Development
 
-# Development
 1. Give execution permissions to all sh files
 `find . -name '*.sh' | xargs git update-index --chmod=+x`
 2. Install pre-commit