From: Sangwook Ha <sangwook.ha@verizon.com>
Date: Thu, 4 Jan 2024 01:29:40 +0000 (-0800)
Subject: Run gitlint with tox
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=6ab2d076771165554025486bce4dc059473c79f5;p=integration%2Ftest.git

Run gitlint with tox

Verification of git message is failing because of a pip installation
issue:
https://github.com/jorisroovers/gitlint/issues/535
https://github.com/pypa/pip/issues/12372

The issue has been addressed for pip v23.3.2:
https://github.com/pypa/pip/releases/tag/23.3.2

but the virtual environment for the pre-commit hook does not appear to
have the version available yet.

Run the gitlint with tox directly until the issue is resolved in the
Jenkins environment.

Change-Id: I033240f8f7bb5a14217dbc763687ac490ae4b3d0
Signed-off-by: Sangwook Ha <sangwook.ha@verizon.com>
---

diff --git a/tox.ini b/tox.ini
index bf2cee0cf5..c016051665 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
 [tox]
 minversion = 1.6.0
-envlist = docs,pre-commit
+envlist = docs,pre-commit,gitlint
 # TODO: Include docs when it starts performing strict checks.
 skipsdist = true
 
@@ -36,7 +36,9 @@ deps = pre-commit
 passenv = HOME
 commands =
     pre-commit run --all-files --show-diff-on-failure
-    pre-commit run gitlint-ci --hook-stage manual
+# FIXME: run gitlint with pre-commit once the following installation issue is resolved
+#        in the Jenkins environment: https://github.com/jorisroovers/gitlint/issues/535
+#    pre-commit run gitlint-ci --hook-stage manual
 
 [testenv:gitlint]
 basepython = python3