Add a gitlint profile and tox configuration 09/102209/4
authorguillaume.lambert <guillaume.lambert@orange.com>
Tue, 23 Aug 2022 13:18:38 +0000 (15:18 +0200)
committerRobert Varga <nite@hq.sk>
Fri, 9 Aug 2024 00:27:57 +0000 (00:27 +0000)
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I8704f9199768ed76b064c438c0b2f9e1578a4241

.gitlint [new file with mode: 0644]
tox.ini

diff --git a/.gitlint b/.gitlint
new file mode 100644 (file)
index 0000000..85c1b7a
--- /dev/null
+++ b/.gitlint
@@ -0,0 +1,81 @@
+# All these sections are optional, edit this file as you like.
+[general]
+# Ignore certain rules, you can reference them by their id or by their full
+# name
+# ignore=title-trailing-punctuation, T3
+# verbosity should be a value between 1 and 3, the command line -v flags take
+# precedence over this
+# verbosity = 2
+# By default gitlint will ignore merge commits. Set to 'false' to disable.
+# ignore-merge-commits=true
+# By default gitlint will ignore fixup commits. Set to 'false' to disable.
+# ignore-fixup-commits=true
+# By default gitlint will ignore squash commits. Set to 'false' to disable.
+# ignore-squash-commits=true
+# Enable debug mode (prints more output). Disabled by default.
+# debug=true
+# Set the extra-path where gitlint will search for user defined rules
+# See http://jorisroovers.github.io/gitlint/user_defined_rules for details
+# extra-path=examples/
+# contrib=contrib-title-conventional-commits,contrib-body-requires-signed-off-b
+contrib=contrib-body-requires-signed-off-by
+[title-max-length]
+# line-length=80
+line-length=50
+# [title-must-not-contain-word]
+# Comma-separated list of words that should not occur in the title. Matching is
+# case insensitive. It's fine if the keyword occurs as part of a larger word
+# (so "WIPING" will not cause a violation, but "WIP: my title" will.
+# words=wip
+# [title-match-regex]
+# python like regex (https://docs.python.org/2/library/re.html) that the
+# commit-msg title must be matched to.
+# Note that the regex can contradict with other rules if not used correctly
+# (e.g. title-must-not-contain-word).
+# regex=^US[0-9]*
+[B1]
+# B1 = body-max-line-length
+# line-length=120
+line-length=72
+# [body-min-length]
+# min-length=5
+# [body-is-missing]
+# Whether to ignore this rule on merge commits (which typically only have a title)
+# default = True
+# ignore-merge-commits=false
+# [body-changed-file-mention]
+# List of files that need to be explicitly mentioned in the body when they are
+# changed This is useful for when developers often erroneously edit certain
+# files or git submodules.  By specifying this rule, developers can only change
+# the file when they explicitly reference it in the commit message.
+# files=gitlint/rules.py,README.md
+# [author-valid-email]
+# python like regex (https://docs.python.org/2/library/re.html) that the
+# commit author email address should be matched to
+# For example, use the following regex if you only want to allow email
+# addresses from foo.com
+# regex=[^@]+@foo.com
+# [ignore-by-title]
+# Ignore certain rules for commits of which the title matches a regex
+# E.g. Match commit titles that start with "Release"
+# regex=^Release(.*)
+#
+# Ignore certain rules, you can reference them by their id or by their full name
+# Use 'all' to ignore all rules
+# ignore=T1,body-min-length
+# [ignore-by-body]
+# Ignore certain rules for commits of which the body has a line that matches a
+# regex
+# E.g. Match bodies that have a line that contain "release"
+# regex=(.*)release(.*)
+#
+# Ignore certain rules, you can reference them by their id or by their full name
+# Use 'all' to ignore all rules
+# ignore=T1,body-min-length
+# Enable Conventional Commit subject line enforcement
+# https://www.conventionalcommits.org/en/v1.0.0/
+#
+# Since we want all subjects to be well formed, enforce the topics
+# to the following (fairly standard) topics and require them to be Mixed Case
+#[contrib-title-conventional-commits]
+#types=Fix,Feat,Chore,Docs,Style,Refactor,Perf,Test,Revert,CI,Build
diff --git a/tox.ini b/tox.ini
index 6848158aaade28de9a2df4d15ece6c262c40c5a6..81162a6e3b30a0bf4911a60a884e1b560fdeb6bf 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -3,6 +3,7 @@ minversion = 1.6
 envlist =
     docs
     docs-linkcheck
+    gitlint
 skipsdist = true
 
 [testenv]
@@ -19,3 +20,8 @@ commands =
 basepython = python3
 commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
 
+[testenv:gitlint]
+basepython = python3
+deps = gitlint
+commands =
+    gitlint