Skip to content

Commit 82abc63

Browse files
committed
(maint) Add commit summary check
This commit adds the `commits` rake task which is run in the Static Code Analysis workflow as a step.
1 parent 86631fa commit 82abc63

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

Rakefile

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,29 @@ EOM
8484
end
8585
end
8686

87+
desc "verify that commit messages match CONTRIBUTING.md requirements"
88+
task(:commits) do
89+
# This rake task looks at the summary from every commit from this branch not
90+
# in the branch targeted for a PR.
91+
commit_range = 'HEAD^..HEAD'
92+
puts "Checking commits #{commit_range}"
93+
%x{git log --no-merges --pretty=%s #{commit_range}}.each_line do |commit_summary|
94+
# This regex tests for the currently supported commit summary tokens.
95+
# The exception tries to explain it in more full.
96+
if /^\((maint|packaging|doc|docs|modules-\d+)\)|revert/i.match(commit_summary).nil?
97+
raise "\n\n\n\tThis commit summary didn't match CONTRIBUTING.md guidelines:\n" \
98+
"\n\t\t#{commit_summary}\n" \
99+
"\tThe commit summary (i.e. the first line of the commit message) should start with one of:\n" \
100+
"\t\t(MODULES-<digits>) # this is most common and should be a ticket at tickets.puppet.com\n" \
101+
"\t\t(docs)\n" \
102+
"\t\t(docs)(DOCUMENT-<digits>)\n" \
103+
"\t\t(packaging)\n"
104+
"\t\t(maint)\n" \
105+
"\n\tThis test for the commit summary is case-insensitive.\n\n\n"
106+
else
107+
puts "#{commit_summary}"
108+
end
109+
puts "...passed"
110+
end
111+
end
112+

0 commit comments

Comments
 (0)