diff options
author | Luchian Nemes <luchian.nemes@puppet.com> | 2020-10-05 18:24:40 +0300 |
---|---|---|
committer | Luchian Nemes <luchian.nemes@puppet.com> | 2020-10-05 18:24:40 +0300 |
commit | 8fc0ec57c50b9b9c25d98849ef97dfd6500874c3 (patch) | |
tree | 818902b1b6ec74b943b90752127e9c617f9037ee /Rakefile | |
parent | 71217a54a2b6442cf9d2b47e5f13a46c5a7b5a5c (diff) | |
download | puppet-augeas_core-8fc0ec57c50b9b9c25d98849ef97dfd6500874c3.tar.gz puppet-augeas_core-8fc0ec57c50b9b9c25d98849ef97dfd6500874c3.tar.bz2 |
(maint) Add commit summary check
This commit adds the `commits` rake task and runs it in the Static Code
Analysis workflow as a step.
Diffstat (limited to 'Rakefile')
-rw-r--r-- | Rakefile | 25 |
1 files changed, 25 insertions, 0 deletions
@@ -84,3 +84,28 @@ EOM end end +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 |