aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Cooper <joshcooper@users.noreply.github.com>2021-08-17 09:11:24 -0700
committerJosh Cooper <joshcooper@users.noreply.github.com>2021-08-17 09:13:17 -0700
commitb088e56f0dda3526df1f20868dbe556770d1bd4a (patch)
tree70d56d19da10ccecfa52c2f88460dc61b54259f6
parent9e54a782d114f64965f9293f3330fac03d7025b8 (diff)
downloadpuppet-cron_core-b088e56f0dda3526df1f20868dbe556770d1bd4a.tar.gz
puppet-cron_core-b088e56f0dda3526df1f20868dbe556770d1bd4a.tar.bz2
(maint) Move extra commits rake task to rakelib
Our `commits` rake task is not part of the standard template, so move it to the `rakelib` directory so it will be deleted when running `pdk update`
-rw-r--r--rakelib/commits.rake25
1 files changed, 25 insertions, 0 deletions
diff --git a/rakelib/commits.rake b/rakelib/commits.rake
new file mode 100644
index 0000000..a900ee2
--- /dev/null
+++ b/rakelib/commits.rake
@@ -0,0 +1,25 @@
+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 /^\((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" \
+ "\n\tThis test for the commit summary is case-insensitive.\n\n\n"
+ else
+ puts "#{commit_summary}"
+ end
+ puts "...passed"
+ end
+end