You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by bb...@apache.org on 2019/09/18 10:52:40 UTC

[mesos] 03/09: Added gitlint config.

This is an automated email from the ASF dual-hosted git repository.

bbannier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mesos.git

commit cbaca81a54720771662c119c80aec6101f120afc
Author: Benjamin Bannier <bb...@apache.org>
AuthorDate: Wed Sep 18 11:37:11 2019 +0200

    Added gitlint config.
    
    This patch adds a config for the gitlint tool which is slated to replace
    a custom commit-msg hook once we switch our hook infrastructure to the
    pre-commit tool.
    
    Review: https://reviews.apache.org/r/71204/
---
 bootstrap         |  4 ++++
 bootstrap.bat     |  4 ++++
 support/gitignore |  1 +
 support/gitlint   | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 57 insertions(+)

diff --git a/bootstrap b/bootstrap
index a8b0da1..e88e8cb 100755
--- a/bootstrap
+++ b/bootstrap
@@ -84,6 +84,10 @@ if test ! -e CPPLINT.cfg; then
   ln -s support/CPPLINT.cfg CPPLINT.cfg
 fi
 
+if test ! -e .gitlint; then
+  ln -s support/gitlint .gitlint
+fi
+
 if [ -n "$AUTOMAKE" ] || [ -n "$ACLOCAL" ] ; then
     if [ -z "$ACLOCAL" ] || [ -z "$AUTOMAKE" ] ; then
         _present="AUTOMAKE"
diff --git a/bootstrap.bat b/bootstrap.bat
index 41447db..7ca6449 100644
--- a/bootstrap.bat
+++ b/bootstrap.bat
@@ -60,6 +60,10 @@ if not exist CPPLINT.cfg (
   mklink CPPLINT.cfg support\CPPLINT.cfg
 )
 
+if not exist .gitlint (
+  mklink .gitlint support\gitlint
+)
+
 goto:eof
 
 
diff --git a/support/gitignore b/support/gitignore
index 484b912..3d53411 100644
--- a/support/gitignore
+++ b/support/gitignore
@@ -5,6 +5,7 @@
 .clang-format
 .clang-tidy
 .reviewboardrc
+.gitlint
 CPPLINT.cfg
 Makefile.in
 aclocal.m4
diff --git a/support/gitlint b/support/gitlint
new file mode 100644
index 0000000..cac9253
--- /dev/null
+++ b/support/gitlint
@@ -0,0 +1,48 @@
+# All these sections are optional, edit this file as you like.
+[general]
+ignore=title-trailing-punctuation, T3, body-is-missing, B6, body-min-length
+# verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this
+# verbosity = 2
+# By default gitlint will ignore merge commits. Set to 'false' to disable.
+# ignore-merge-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/
+
+[title-max-length]
+line-length=72
+
+# [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]*
+regex=^[A-Z].*\.$
+
+[body-max-line-length]
+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