zola-check-manager

commit 83302825ae3825875e864c6c550a309efedc7fae
parent e18aff582a59e07033a84465434a26f30f905525
Author: MTRNord <mtrnord1@gmail.com>
Date:   Sat, 15 Apr 2023 18:34:54 +0200

feat: Add pre-commit config for commits

Diffstat:
A
.pre-commit-config.yaml
 | 
19
+++++++++++++++++++
M
README.md
 | 
6
++++++

2 files changed, 25 insertions(+), 0 deletions(-)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v2.1.1
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args:
+          [
+            "feat",
+            "fix",
+            "docs",
+            "perf",
+            "refactor",
+            "style",
+            "test",
+            "chore",
+            "security",
+          ]
+\ No newline at end of file
diff --git a/README.md b/README.md
@@ -33,3 +33,9 @@ jobs:
 * `working_directory`: The folder where the `zola check` should be executed. Default: `.`
 * `repo-token`: The token to use to authenticate with Github. Default: `${{ secrets.GITHUB_TOKEN }}`. This requires the `checks:write` permission.
 * `conclusion_level`: The conclusion level to use. Can be `action_required`, `failure`, `neutral`, `success`. Default: `action_required`
+
+## Commit Guideline
+
+Please use [conventional commits](https://www.conventionalcommits.org). You can use the pre-commit script to ensure you
+do use conventional commits by running `pre-commit install -t prepare-commit-msg -t commit-msg`
+after [installing pre-commit](https://pre-commit.com/#install).