diff options
| -rw-r--r-- | .github/workflows/static_code_analysis.yaml | 5 | ||||
| -rw-r--r-- | Rakefile | 25 |
2 files changed, 30 insertions, 0 deletions
diff --git a/.github/workflows/static_code_analysis.yaml b/.github/workflows/static_code_analysis.yaml index ed4a232..9b94bf8 100644 --- a/.github/workflows/static_code_analysis.yaml +++ b/.github/workflows/static_code_analysis.yaml @@ -19,6 +19,8 @@ jobs: steps: - name: Checkout current PR code uses: actions/checkout@v2 + with: + fetch-depth: 0 - name: Install ruby version ${{ env.ruby_version }} uses: ruby/setup-ruby@v1 @@ -28,6 +30,9 @@ jobs: - name: Prepare testing environment with bundler run: bundle update --jobs 4 --retry 3 + - name: Run commits check + run: bundle exec rake commits + - name: Run rubocop check run: bundle exec rake ${{ env.extra_checks }} rubocop @@ -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 |