michaelh/zephyr
1
0
Fork 0
Code Releases Activity

gitlint: check for subsystem in commit subject

Browse source 
Check that we have <subsystem>: <subject> in commit messages.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2017-05-05 19:37:52 -04:00 • committed by Anas Nashif
commit 3c27c46562
2 changed files with 19 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.gitlint
View file

@ -19,6 +19,9 @@ max-line-count=200
[title-max-length] [title-max-length]
line-length=72 line-length=72
[title-starts-with-subsystem]
regex = ^(([^:]+):)(\s([^:]+):)*\s(.+)$
[title-must-not-contain-word] [title-must-not-contain-word]
# Comma-separated list of words that should not occur in the title. Matching is case # 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" # insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING"

19
scripts/gitlint/zephyr_commit_rules.py
View file

@ -1,5 +1,5 @@
from gitlint.rules import CommitRule, RuleViolation from gitlint.rules import CommitRule, RuleViolation, TitleRegexMatches, CommitMessageTitle, LineRule
from gitlint.options import IntOption from gitlint.options import IntOption, BoolOption, StrOption, ListOption
import re import re
""" """
@ -33,7 +33,6 @@ class BodyMaxLineCount(CommitRule):
message = "Body contains too many lines ({0} > {1})".format(line_count, max_line_count) message = "Body contains too many lines ({0} > {1})".format(line_count, max_line_count)
return [RuleViolation(self.id, message, line_nr=1)] return [RuleViolation(self.id, message, line_nr=1)]
class SignedOffBy(CommitRule): class SignedOffBy(CommitRule):
""" This rule will enforce that each commit contains a "Signed-Off-By" line. """ This rule will enforce that each commit contains a "Signed-Off-By" line.
We keep things simple here and just check whether the commit body contains a line that starts with "Signed-Off-By". We keep things simple here and just check whether the commit body contains a line that starts with "Signed-Off-By".
@ -55,3 +54,17 @@ class SignedOffBy(CommitRule):
else: else:
return return
return [RuleViolation(self.id, "Body does not contain a 'Signed-Off-By' line", line_nr=1)] return [RuleViolation(self.id, "Body does not contain a 'Signed-Off-By' line", line_nr=1)]
class TitleStartsWithSubsystem(LineRule):
name = "title-starts-with-subsystem"
id = "UC3"
target = CommitMessageTitle
options_spec = [StrOption('regex', ".*", "Regex the title should match")]
def validate(self, title, _commit):
regex = self.options['regex'].value
pattern = re.compile(regex, re.UNICODE)
violation_message = "Title does not follow <subsystem>: <subject>"
if not pattern.search(title):
return [RuleViolation(self.id, violation_message, title)]