From: Andrew Grimberg <agrimberg@linuxfoundation.org>
Date: Mon, 28 Jun 2021 17:32:58 +0000 (-0700)
Subject: CI: Properly run gitlint in CI
X-Git-Tag: v0.35.2~2
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=9fa943e01f4bb4961714a6bab74ae2b90801308e;p=releng%2Flftools.git

CI: Properly run gitlint in CI

When running pre-commit in a CI system the COMMIT_EDITMSG does not
(normally) get created as that is an artifact of editing the commit
message. If the file doesn't exist then gitlint will skip which makes it
possible for pre-commit checks that should fail, to pass.

Since we want tox to run in a consistent manner both locally and in CI
we need to play around a little with how we are checking the commit
message.

Change-Id: I25c1815ea3195e47a67b529a06497ad3594b2c84
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
---

diff --git a/releasenotes/notes/convential_commit-a24e8a18c540c91f.yaml b/releasenotes/notes/convential_commit-a24e8a18c540c91f.yaml
new file mode 100644
index 00000000..c642e8b9
--- /dev/null
+++ b/releasenotes/notes/convential_commit-a24e8a18c540c91f.yaml
@@ -0,0 +1,10 @@
+---
+other:
+  - |
+    Conventional Commit message subject lines are now enforced. This affects
+    CI. Additionally, if developers want to protect themselves from CI failing
+    on this please make sure of the following
+
+    * you have pre-commit installed
+    * that you have run
+      pre-commit install --hook-type commit-msg
diff --git a/tox.ini b/tox.ini
index 2525c1eb..d8335470 100644
--- a/tox.ini
+++ b/tox.ini
@@ -62,10 +62,30 @@ commands =
 [testenv:pre-commit]
 description = Precommit checks for black, gitlint, etc.
 basepython = python3
-deps = pre-commit
+allowlist_externals =
+    /bin/sh
+deps =
+    pre-commit
+passenv = HOME
 commands =
     pre-commit run --all-files --show-diff-on-failure
-    pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
+    /bin/sh -c 'if ! git config --get user.name > /dev/null; then \
+        git config --global --add user.name "CI"; \
+        touch .git/REMOVE_USERNAME; fi'
+    /bin/sh -c 'if ! git config --get user.email > /dev/null; then \
+        git config --global --add user.email "ci@example.org"; \
+        touch .git/REMOVE_USEREMAIL; fi'
+    /bin/sh -c "if [ -f .git/COMMIT_EDITMSG ]; then \
+        cp .git/COMMIT_EDITMSG .git/COMMIT_MSGTOX; else \
+        git log HEAD -n1 --pretty=%B > .git/COMMIT_MSGTOX; fi"
+    pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_MSGTOX
+    /bin/sh -c "rm -f .git/COMMIT_MSGTOX"
+    /bin/sh -c "if [ -f .git/REMOVE_USERNAME ]; then \
+        git config --global --unset user.name; \
+        rm -f .git/REMOVE_USERNAME; fi"
+    /bin/sh -c "if [ -f .git/REMOVE_USEREMAIL ]; then \
+        git config --global --unset user.email; \
+        rm -f .git/REMOVE_USEREMAIL; fi"
 
 [testenv:reno]
 description = OpenStack Reno checks