Browse Source

Add a pre-commit hook that runs code and changelog entry formatting checks

rl1987 5 years ago
parent
commit
99fffc6c2f
2 changed files with 27 additions and 0 deletions
  1. 4 0
      changes/feature28976
  2. 23 0
      scripts/maint/pre-commit.git-hook

+ 4 - 0
changes/feature28976

@@ -0,0 +1,4 @@
+  o Minor features (developer tooling):
+    - Provide a git pre-commit hook that disallows commiting if we have any
+      failures in our code and changelog formatting checks. It is now available
+      in scripts/maint/pre-commit.git-hook. Implements feature 28976.

+ 23 - 0
scripts/maint/pre-commit.git-hook

@@ -0,0 +1,23 @@
+#!/bin/bash
+#
+# To install this script, copy it to .git/hooks/pre-commit in local copy of
+# tor git repo and make sure it has permission to execute.
+#
+# This is pre-commit git hook script that prevents commiting your changeset if
+# it fails our code formatting or changelog entry formatting checkers.
+
+workdir=$(git rev-parse --show-toplevel)
+
+cd "$workdir" || exit 1
+
+python scripts/maint/lintChanges.py ./changes
+
+perl scripts/maint/checkSpace.pl -C \
+src/lib/*/*.[ch] \
+src/core/*/*.[ch] \
+src/feature/*/*.[ch] \
+src/app/*/*.[ch] \
+src/test/*.[ch] \
+src/test/*/*.[ch] \
+src/tools/*.[ch]
+