aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Hashizume <michael.hashizume@puppet.com>2023-10-03 08:24:04 -0700
committerMichael Hashizume <michael.hashizume@puppet.com>2023-10-03 08:24:18 -0700
commitbaa7fa2cc8e771a131a58ac2f932c4b59884c829 (patch)
tree367951f72aa7d05d99c087e0899686d6834e1827
parente18d8b0c3e1099c923d695c7a723fcde1c1a18dd (diff)
downloadpuppet-hosts_core-baa7fa2cc8e771a131a58ac2f932c4b59884c829.tar.gz
puppet-hosts_core-baa7fa2cc8e771a131a58ac2f932c4b59884c829.tar.bz2
(maint) Update commit check
This commit updates the commits Rake check to include commit summaries that begin with the Puppet Agent (PA) Jira project and removes references to a non-existent CONTRIBUTION.md.
-rw-r--r--rakelib/commits.rake13
1 files changed, 6 insertions, 7 deletions
diff --git a/rakelib/commits.rake b/rakelib/commits.rake
index 5e0578e..7cee9fa 100644
--- a/rakelib/commits.rake
+++ b/rakelib/commits.rake
@@ -1,4 +1,4 @@
-desc "verify that commit messages match CONTRIBUTING.md requirements"
+desc "verify that commit summaries are properly formatted"
task(:commits) do
# This rake task looks at the summary from every commit from this branch not
# in the branch targeted for a PR.
@@ -7,16 +7,15 @@ task(:commits) do
%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" \
+ if /^Release prep|\((maint|packaging|doc|docs|modules|pa-\d+)\)|revert/i.match(commit_summary).nil?
+ raise "\n\n\n\tPlease make sure that your commit summary (i.e. the first line of the commit message) starts with one of the following:\n" \
+ "\t\t(PA-<digits>)\n" \
+ "\t\t(MODULES-<digits>)\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" \
+ "\t\tRelease prep v<tag>\n" \
"\n\tThis test for the commit summary is case-insensitive.\n\n\n"
else
puts "#{commit_summary}"