patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

gitlint: do not allow treewide as an area in commit messages

Browse source 
Treewide changes touching a single area or topic should have the
area/subsystem at the start of the commit message. Treewide is very
ambigous.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2024-04-04 09:03:31 -04:00 committed by Alberto Escolar
parent b9f3d68863
commit 66af7a6881
3 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitlint
View file

@ -26,7 +26,7 @@ extra-path=scripts/gitlint
# max-line-count=200 # max-line-count=200
[title-starts-with-subsystem] [title-starts-with-subsystem]
regex = ^(?!subsys:)(([^:]+):)(\s([^:]+):)*\s(.+)$ regex = ^(?!subsys:)(?!treewide:)(([^:]+):)(\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

1
scripts/ci/twister_ignore.txt
View file

@ -45,3 +45,4 @@ scripts/checkpatch.pl
scripts/ci/pylintrc scripts/ci/pylintrc
scripts/footprint/* scripts/footprint/*
scripts/set_assignees.py scripts/set_assignees.py
scripts/gitlint/zephyr_commit_rules.py

2
scripts/gitlint/zephyr_commit_rules.py
View file

@ -95,7 +95,7 @@ class TitleStartsWithSubsystem(LineRule):
def validate(self, title, _commit): def validate(self, title, _commit):
regex = self.options['regex'].value regex = self.options['regex'].value
pattern = re.compile(regex, re.UNICODE) pattern = re.compile(regex, re.UNICODE)
violation_message = "Commit title does not follow [subsystem]: [subject] (and should not start with literal subsys:)" violation_message = "Commit title does not follow [subsystem]: [subject] (and should not start with literal subsys or treewide)"
if not pattern.search(title): if not pattern.search(title):
return [RuleViolation(self.id, violation_message, title)] return [RuleViolation(self.id, violation_message, title)]