Print git-diff when pre-commit fails 16/64216/1
authorThanh Ha <zxiiro@gmail.com>
Sat, 6 Jun 2020 13:43:00 +0000 (09:43 -0400)
committerThanh Ha <zxiiro@gmail.com>
Sat, 6 Jun 2020 13:44:22 +0000 (09:44 -0400)
When pre-commit fails and automatically fixes issues for us in Jenkins
we are not able to see what pre-commit automatically fixed. Adding
--show-diff-on-failure makes pre-commit perform a git-diff immediately
after failing to ensure more useful output is printed to inform the
contributor what changes are needed to pass the check.

Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I0c9fc6afa8be214d03e342b2913205e946aa901e

tox.ini

diff --git a/tox.ini b/tox.ini
index 06b418a..3230bab 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -69,7 +69,7 @@ basepython = python3
 deps =
     pre-commit
 commands =
-    pre-commit run --all-files
+    pre-commit run --all-files --show-diff-on-failure
     pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
 
 #########