aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Hashizume <michael.hashizume@puppet.com>2024-02-01 16:44:58 -0800
committerMichael Hashizume <michael.hashizume@puppet.com>2024-02-02 09:35:35 -0800
commitceb521d16751f4f4b1ee577827f14ccc9380ed45 (patch)
treeaff7414b649f17cade074eece190811e6980acac
parentbf45fba3850ff5b9c68cc54cf2d43857fd93b16c (diff)
downloadpuppet-mailalias_core-ceb521d16751f4f4b1ee577827f14ccc9380ed45.tar.gz
puppet-mailalias_core-ceb521d16751f4f4b1ee577827f14ccc9380ed45.tar.bz2
Use reusable static code analysis
This commit updates the static code analysis GitHub Actions workflow from using a copy in this repository to a resuable copy in the Phoenix team centralized GitHub Actions repository. In addition, this removes the commits Rake task as it is no longer used in the reusable version of this workflow.
-rw-r--r--.github/workflows/static_code_analysis.yaml40
-rw-r--r--rakelib/commits.rake26
2 files changed, 2 insertions, 64 deletions
diff --git a/.github/workflows/static_code_analysis.yaml b/.github/workflows/static_code_analysis.yaml
index b639220..62438da 100644
--- a/.github/workflows/static_code_analysis.yaml
+++ b/.github/workflows/static_code_analysis.yaml
@@ -6,44 +6,8 @@ on:
branches: [ main ]
pull_request:
branches: [ main ]
+ workflow_dispatch:
jobs:
static_code_analysis:
- name: Run checks
-
- env:
- ruby_version: 2.6
- extra_checks: check:symlinks check:git_ignore check:dot_underscore check:test_file
-
- runs-on: 'ubuntu-20.04'
- steps:
- - name: Checkout current PR code
- uses: actions/checkout@v3
- with:
- fetch-depth: 0
-
- - name: Install ruby version ${{ env.ruby_version }}
- uses: ruby/setup-ruby@v1
- with:
- ruby-version: ${{ env.ruby_version }}
-
- - name: Prepare testing environment with bundler
- run: |
- git config --global core.longpaths true
- bundle config set --local without 'release'
- 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
-
- - name: Run syntax check
- run: bundle exec rake ${{ env.extra_checks }} syntax syntax:hiera syntax:manifests syntax:templates
-
- - name: Run lint check
- run: bundle exec rake ${{ env.extra_checks }} lint
-
- - name: Run metadata_lint check
- run: bundle exec rake ${{ env.extra_checks }} metadata_lint
+ uses: "puppetlabs/phoenix-github-actions/.github/workflows/static_code_analysis.yaml@main"
diff --git a/rakelib/commits.rake b/rakelib/commits.rake
deleted file mode 100644
index 42eb209..0000000
--- a/rakelib/commits.rake
+++ /dev/null
@@ -1,26 +0,0 @@
-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