Setup dependabot to keep python 3rd parties dependencies up to date (such as platform.io)

Author: sebastienvermeille

.github/dependabot.yml

@@ -12,4 +12,4 @@ updates:
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "daily"

.github/workflows/build.yml

@@ -36,4 +36,9 @@ jobs:
 
       - name: Compile firmware
         run: |
-          make build
+          make build
+
+      - name: Perform pre-commit checks
+        # ensure files are correctly formatted, Markdown, yaml, end of file etc.
+        run: |
+          make pre-commit

.markdownlint.yaml

@@ -0,0 +1,7 @@
+# Default state for all rules
+default: true
+
+# MD013/line-length - Line length
+MD013:
+  line_length: 120
+  tables: false

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0  # v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.30.0  # 0.22.0
+    hooks:
+      - id: check-github-workflows
+  - repo: https://github.com/gruntwork-io/pre-commit
+    rev: v0.1.24 # v0.1.20
+    hooks:
+      - id: shellcheck
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0 # v0.39.0
+    hooks:
+      - id: markdownlint

Makefile

@@ -27,3 +27,7 @@ monitor:
 install:
 	@echo "Installing dependencies..."
 	pipenv install --ignore-pipfile
+
+pre-commit:
+	@echo "Run pre-commit checks..."
+	pipenv run pre-commit run --all-files

Pipfile

@@ -5,6 +5,7 @@ name = "pypi"
 
 [packages]
 platformio = "*"
+pre-commit = "*"
 
 [dev-packages]
 

Pipfile.lock

@@ -0,0 +1,4 @@
+# NSPanelManager - NSPanel Firmware
+
+This project contains the custom firmware to allow compatible NSPanel
+to communicate with [NSPanelManager](https://nspanelmanager.com).