aboutsummaryrefslogtreecommitdiff
path: root/rakelib/commits.rake
diff options
context:
space:
mode:
authorGabriel Nagy <gabriel.nagy@puppet.com>2021-10-04 11:00:55 +0300
committerGabriel Nagy <gabriel.nagy@puppet.com>2021-10-04 11:20:54 +0300
commit15049eff83d9fc6231daa4dc85cd34b9d5b2d65b (patch)
treebe9d5fd8bd1be4909f91b306b7221ada9331bba3 /rakelib/commits.rake
parentec3ca459f0f3d774119b8fba37390bf212c06923 (diff)
downloadpuppet-mailalias_core-15049eff83d9fc6231daa4dc85cd34b9d5b2d65b.tar.gz
puppet-mailalias_core-15049eff83d9fc6231daa4dc85cd34b9d5b2d65b.tar.bz2
(MODULES-11197) Update to pdk-templates 2.2.0
Includes REFERENCE.md ToC fixes for MODULES-8183.
Diffstat (limited to 'rakelib/commits.rake')
-rw-r--r--rakelib/commits.rake26
1 files changed, 26 insertions, 0 deletions
diff --git a/rakelib/commits.rake b/rakelib/commits.rake
new file mode 100644
index 0000000..42eb209
--- /dev/null
+++ b/rakelib/commits.rake
@@ -0,0 +1,26 @@
+desc "verify that commit messages match CONTRIBUTING.md requirements"
+task(:commits) do
+ # This rake task looks at the summary from every commit from this branch not
+ # in the branch targeted for a PR.
+ commit_range = 'HEAD^..HEAD'
+ puts "Checking commits #{commit_range}"
+ %x{git log --no-merges --pretty=%s #{commit_range}}.each_line do |commit_summary|
+ # This regex tests for the currently supported commit summary tokens.
+ # The exception tries to explain it in more full.
+ if /^Release prep|\((maint|packaging|doc|docs|modules-\d+)\)|revert/i.match(commit_summary).nil?
+ raise "\n\n\n\tThis commit summary didn't match CONTRIBUTING.md guidelines:\n" \
+ "\n\t\t#{commit_summary}\n" \
+ "\tThe commit summary (i.e. the first line of the commit message) should start with one of:\n" \
+ "\t\t(MODULES-<digits>) # this is most common and should be a ticket at tickets.puppet.com\n" \
+ "\t\t(docs)\n" \
+ "\t\t(docs)(DOCUMENT-<digits>)\n" \
+ "\t\t(packaging)\n"
+ "\t\t(maint)\n" \
+ "\t\tRelease prep v<tag>\n" \
+ "\n\tThis test for the commit summary is case-insensitive.\n\n\n"
+ else
+ puts "#{commit_summary}"
+ end
+ puts "...passed"
+ end
+end