👷 Setup GHA

pboling · pboling · commit 33b607bf51cb · 2025-02-19T05:21:25.000+07:00
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -38,11 +38,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v3
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -1,16 +1,16 @@
-name: Ruby - Coverage
+name: Test Coverage
 
 env:
-  K_SOUP_COV_MIN_BRANCH: 82
-  K_SOUP_COV_MIN_LINE: 94
+  K_SOUP_COV_MIN_BRANCH: 100
+  K_SOUP_COV_MIN_LINE: 100
   K_SOUP_COV_MIN_HARD: true
+  K_SOUP_COV_DO: true
+  K_SOUP_COV_COMMAND_NAME: "RSpec Coverage"
 
 on:
   push:
     branches:
       - 'main'
-      - '*-stable'
-      - '*-dev'
     tags:
       - '!*' # Do not execute on tags
   pull_request:
@@ -32,48 +32,54 @@ jobs:
   test:
     name: Specs with Coverage - Ruby ${{ matrix.ruby }} ${{ matrix.name_extra || '' }}
     if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
-      CI_CODECOV: true
-      COVER_ALL: true
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
+    env: # $BUNDLE_GEMFILE must be set at job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}.gemfile
     strategy:
+      fail-fast: false
       matrix:
-        rubygems:
-          - latest
-        bundler:
-          - latest
-        gemfile:
-          - coverage
-        ruby:
-          - '3.1'
+        include:
+          # Coverage
+          - ruby: "3.4"
+            appraisal: "coverage"
+            exec_cmd: "rake rspec"
+            gemfile: "Appraisal.root"
+            rubygems: latest
+            bundler: latest
 
     steps:
-      - name: CodeClimate Install
-        uses: amancevice/setup-code-climate@v1
+      - uses: amancevice/setup-code-climate@v2
+        name: CodeClimate Install
         if: ${{ github.event_name != 'pull_request' }}
         with:
-          cc_test_reporter_id: "${{ secrets.CC_TEST_REPORTER_ID }}"
+          cc_test_reporter_id: ${{ secrets.CC_TEST_REPORTER_ID }}
 
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup Ruby & Bundle
+      - name: Setup Ruby & RubyGems
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: "${{ matrix.ruby }}"
           rubygems: "${{ matrix.rubygems }}"
           bundler: "${{ matrix.bundler }}"
-          bundler-cache: true
+          bundler-cache: false
 
       - name: CodeClimate Pre-build Notification
         run: cc-test-reporter before-build
         if: ${{ github.event_name != 'pull_request' }}
         continue-on-error: ${{ matrix.experimental != 'false' }}
 
-      - name: Run tests
-        run: bundle exec rake test
+      # Raw `bundle` will use the BUNDLE_GEMFILE set to matrix.gemfile (i.e. Appraisal.root)
+      # We need to do this first to get appraisal installed.
+      # NOTE: This does not use the main Gemfile at all.
+      - name: Bundle install for Appraisal ${{ matrix.appraisal }}
+        run: bundle
+      - name: Install Appraisal ${{ matrix.appraisal }} dependencies
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle
+      - name: Run ${{ matrix.appraisal }} tests via ${{ matrix.exec_cmd }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}
 
       - name: CodeClimate Post-build Notification
         run: cc-test-reporter after-build
@@ -92,7 +98,7 @@ jobs:
           hide_complexity: true
           indicators: true
           output: both
-          thresholds: '93 82'
+          thresholds: '69 80'
         continue-on-error: ${{ matrix.experimental != 'false' }}
 
       - name: Add Coverage PR Comment
@@ -106,5 +112,10 @@ jobs:
       - name: Coveralls
         uses: coverallsapp/github-action@master
         with:
-          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
         continue-on-error: ${{ matrix.experimental != 'false' }}
+
+      - name: Upload results to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -17,4 +17,4 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v4
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v2
+        uses: actions/dependency-review-action@v4
diff --git a/.github/workflows/heads.yml b/.github/workflows/heads.yml
@@ -1,4 +1,4 @@
-name: Ruby Heads Matrix
+name: Heads Compat Matrix
 
 env:
   K_SOUP_COV_DO: false
@@ -7,8 +7,6 @@ on:
   push:
     branches:
       - 'main'
-      - '*-stable'
-      - '*-dev'
     tags:
       - '!*' # Do not execute on tags
   pull_request:
@@ -28,37 +26,59 @@ concurrency:
 
 jobs:
   test:
-    name: Specs - Ruby ${{ matrix.ruby }} ${{ matrix.name_extra || '' }}
+    name: Specs - Ruby ${{ matrix.ruby }} ${{ matrix.appraisal }}${{ matrix.name_extra || '' }}
     if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
+    env: # $BUNDLE_GEMFILE must be set at job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}.gemfile
     strategy:
       fail-fast: true
       matrix:
-        rubygems:
-          - latest
-        bundler:
-          - latest
-        gemfile:
-          - vanilla
-        ruby:
-          - "ruby-head"
-          # TODO: Use rspec-pending_for to exempt (and document) truffleruby-head from specific tests that are failing
-          # - truffleruby-head
+        include:
+          # ruby-head
+          - ruby: "ruby-head"
+            appraisal: "ruby-head"
+            exec_cmd: "rake rspec"
+            gemfile: "Appraisal.root"
+            rubygems: latest
+            bundler: latest
+
+          # truffleruby-head
+          - ruby: "truffleruby-head"
+            appraisal: "truffleruby-head"
+            exec_cmd: "rake rspec"
+            gemfile: "Appraisal.root"
+            rubygems: latest
+            bundler: latest
+
+          # jruby-head
+          # Error output has a significantly different format in JRuby :(
+          #  - ruby: "jruby-head"
+          #    appraisal: "jruby-head"
+          #    exec_cmd: "rake rspec"
+          #    gemfile: "Appraisal.root"
+          #    rubygems: latest
+          #    bundler: latest
 
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup Ruby & Bundle
+      - name: Setup Ruby & RubyGems
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "${{ matrix.ruby }}"
-          rubygems: "${{ matrix.rubygems }}"
-          bundler: "${{ matrix.bundler }}"
-          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+          rubygems: ${{ matrix.rubygems }}
+          bundler: ${{ matrix.bundler }}
+          bundler-cache: false
 
-      - name: Run tests
-        run: bundle exec rake test
+      # Raw `bundle` will use the BUNDLE_GEMFILE set to matrix.gemfile (i.e. Appraisal.root)
+      # We need to do this first to get appraisal installed.
+      # NOTE: This does not use the main Gemfile at all.
+      - name: Bundle install for Appraisal ${{ matrix.appraisal }}
+        run: bundle
+      - name: Install Appraisal ${{ matrix.appraisal }} dependencies
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle
+      - name: Run ${{ matrix.appraisal }} tests via ${{ matrix.exec_cmd }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}
diff --git a/.github/workflows/hoary.yml b/.github/workflows/hoary.yml
@@ -34,7 +34,7 @@ jobs:
           - ruby: "2.2"
             appraisal: "ruby-2-2"
             exec_cmd: "rake rspec"
-            gemfile: "Appraisal.root"
+            gemfile: "Appraisal.hoary"
             rubygems: "2.7.11"
             bundler: "1.17.3"
 
@@ -55,6 +55,15 @@ jobs:
       # NOTE: This does not use the main Gemfile at all.
       - name: Bundle install for Appraisal ${{ matrix.appraisal }}
         run: bundle
+      - name: Overwrite Appraisals
+        run: |
+          cat <<EOF > Appraisals
+          # frozen_string_literal: true
+          appraise "ruby-2-2" do
+          gem "mutex_m", "~> 0.2"
+          gem "stringio", "~> 3.0"
+          end
+          EOF
       - name: Install Appraisal ${{ matrix.appraisal }} dependencies
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle
       - name: Run ${{ matrix.appraisal }} tests via ${{ matrix.exec_cmd }}
diff --git a/.github/workflows/legacy.yml b/.github/workflows/legacy.yml
@@ -1,11 +1,12 @@
-name: Legacy Ruby Support
+name: Legacy Compat (EOL, Ruby 3.0) Matrix
+
+env:
+  K_SOUP_COV_DO: false
 
 on:
   push:
     branches:
       - 'main'
-      - '*-stable'
-      - '*-dev'
     tags:
       - '!*' # Do not execute on tags
   pull_request:
@@ -14,45 +15,53 @@ on:
   # Allow manually triggering the workflow.
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 # Cancels all previous workflow runs for the same branch that have not yet completed.
 concurrency:
   # The concurrency group contains the workflow name and the branch name.
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: "${{ github.workflow }}-${{ github.ref }}"
   cancel-in-progress: true
 
 jobs:
   test:
-    name: Ruby ${{ matrix.ruby }} ${{ matrix.name_extra || '' }}
+    name: Specs - Ruby ${{ matrix.ruby }} ${{ matrix.appraisal }}${{ matrix.name_extra || '' }}
     if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+    runs-on: ubuntu-22.04
+    continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
+    env: # $BUNDLE_GEMFILE must be set at job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}.gemfile
     strategy:
       fail-fast: false
       matrix:
-        experimental: [false]
-        rubygems:
-          - "2.7.11"
-        bundler:
-          - none
-        gemfile:
-          - vanilla
-        ruby:
-          - "3.0"
-          - "2.7"
-          - "2.6"
-          - "2.5"
-          - "2.4"
-    runs-on: ubuntu-20.04
-    continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
+        include:
+          # Ruby 3.0
+          - ruby: "3.0"
+            appraisal: "ruby-3-0"
+            exec_cmd: "rake rspec"
+            gemfile: "Appraisal.root"
+            rubygems: '3.5.23'
+            bundler: '2.5.23'
+
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Ruby & Bundle
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby & RubyGems
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           rubygems: ${{ matrix.rubygems }}
           bundler: ${{ matrix.bundler }}
-          bundler-cache: true
-      - name: Run tests
-        run: bundle exec rake test
+          bundler-cache: false
+
+      # Raw `bundle` will use the BUNDLE_GEMFILE set to matrix.gemfile (i.e. Appraisal.root)
+      # We need to do this first to get appraisal installed.
+      # NOTE: This does not use the main Gemfile at all.
+      - name: Bundle install for Appraisal ${{ matrix.appraisal }}
+        run: bundle
+      - name: Install Appraisal ${{ matrix.appraisal }} dependencies
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle
+      - name: Run ${{ matrix.appraisal }} tests via ${{ matrix.exec_cmd }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}
diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml
diff --git a/.github/workflows/supported.yml b/.github/workflows/supported.yml
diff --git a/.github/workflows/unsupported.yml b/.github/workflows/unsupported.yml
