Update continuous integration and experimental ruby builds

Author: jcouball

.github/workflows/main.yml renamed to .github/workflows/continuous_integration.yml

@@ -1,27 +1,39 @@
-name: Ruby
+name: Continuous Integration
 
 on:
   push:
-    branches:
-      - main
+    branches: [main]
 
   pull_request:
-    branches: [ main ]
+    branches: [main]
+
+  workflow_dispatch:
+
+# Supported platforms / Ruby versions:
+#  - Ubuntu: MRI (3.1, 3.2, 3.3), TruffleRuby (24), JRuby (9.4)
+#  - Windows: MRI (3.1), JRuby (9.4)
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.ruby == 'head' }}
+    name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
+
+    runs-on: ${{ matrix.operating-system }}
+    continue-on-error: true
+
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.0', '3.1', '3.2', 'head']
-
-    name: Build on Ruby ${{ matrix.ruby }}
+        ruby: ["3.1", "3.2", "3.3", "jruby-9.4", "truffleruby-24"]
+        operating-system: [ubuntu-latest]
+        include:
+          - ruby: "3.1"
+            operating-system: windows-latest
+          - ruby: "jruby-9.4"
+            operating-system: windows-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Initialize Ruby
         uses: ruby/setup-ruby@v1
@@ -33,22 +45,21 @@ jobs:
         run: bundle exec rake
 
   coverage:
-    needs: [ build ]
-    runs-on: ubuntu-latest
-
     name: Report test coverage to CodeClimate
 
+    needs: [build]
+    runs-on: ubuntu-latest
+
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Initialize Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.1
           bundler-cache: true
 
-
       - name: Report test coverage
         uses: paambaati/codeclimate-action@v9
         env:

.github/workflows/experimental_ruby_builds.yml

@@ -0,0 +1,46 @@
+name: Experimental Ruby Builds
+
+on:
+  push:
+    branches: [main]
+
+  workflow_dispatch:
+
+# Experimental platforms / Ruby versions:
+#  - Ubuntu: MRI (head), TruffleRuby (head), JRuby (head)
+#  - Windows: MRI (head), JRuby (head)
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
+    
+    runs-on: ${{ matrix.operating-system }}
+    continue-on-error: true
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: head
+            operating-system: ubuntu-latest
+          - ruby: head
+            operating-system: windows-latest
+          - ruby: truffleruby-head
+            operating-system: ubuntu-latest
+          - ruby: jruby-head
+            operating-system: ubuntu-latest
+          - ruby: jruby-head
+            operating-system: windows-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Initialize Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run rake
+        run: bundle exec rake

.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
   SuggestExtensions: false
   # RuboCop enforces rules depending on the oldest version of Ruby which
   # your project supports:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
 
 # The default max line length is 80 characters
 Layout/LineLength:

.solargraph.yml

@@ -3,7 +3,11 @@
 # The default task
 
 desc 'Run the same tasks that the CI build will run'
-task default: %w[spec rubocop yard yard:audit yard:coverage bundle:audit build]
+if RUBY_PLATFORM == 'java'
+  task default: %w[spec rubocop bundle:audit build]
+else
+  task default: %w[spec rubocop yard bundle:audit build]
+end
 
 # Bundler Audit
 
@@ -30,6 +34,11 @@ CLOBBER << 'Gemfile.lock'
 
 require 'rspec/core/rake_task'
 
+if RUBY_PLATFORM == 'java'
+  ENV['JAVA_OPTS'] = '-Djdk.io.File.enableADS=true'
+  ENV['JRUBY_OPTS'] = '--debug'
+end
+
 RSpec::Core::RakeTask.new
 
 CLEAN << 'coverage'
@@ -49,38 +58,40 @@ end
 
 CLEAN << 'rubocop-report.json'
 
-# YARD
+unless RUBY_PLATFORM == 'java'
+  # yard:build
 
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.files = %w[lib/**/*.rb examples/**/*]
-  t.stats_options = ['--list-undoc']
-end
+  require 'yard'
 
-CLEAN << '.yardoc'
-CLEAN << 'doc'
+  YARD::Rake::YardocTask.new('yard:build') do |t|
+    t.files = %w[lib/**/*.rb examples/**/*]
+    t.options = %w[--no-private]
+    t.stats_options = %w[--list-undoc]
+  end
 
-# Yardstick
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
 
-desc 'Run yardstick to show missing YARD doc elements'
-task :'yard:audit' do
-  sh "yardstick 'lib/**/*.rb'"
-end
+  # yard:audit
 
-# Yardstick coverage
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
 
-require 'yardstick/rake/verify'
+  # yard:coverage
 
-Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
-  verify.threshold = 100
-end
+  require 'yardstick/rake/verify'
 
-# # Solargraph typecheck
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+  end
 
-# desc 'Run the solargraph type checker'
-# task :'solargraph:typecheck' do
-#   sh 'bundle exec solargraph typecheck --level=typed'
-# end
+  # yard
+
+  desc 'Run all YARD tasks'
+  task yard: %i[yard:build yard:audit yard:coverage]
+end
 
 # Additional cleanup
 

Rakefile

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   DESCRIPTION
   spec.homepage = 'https://github.com/main-branch/create_github_release'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -34,23 +34,28 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.requirements = [
+    'Platform: Mac, Linux, or Windows',
+    'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
+  ]
 
   spec.add_dependency 'version_boss', '~> 0.1'
 
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
-  spec.add_development_dependency 'debug', '~> 1.9'
+  # spec.add_development_dependency 'debug', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 13.2'
-  spec.add_development_dependency 'redcarpet', '~> 3.6'
   spec.add_development_dependency 'rspec', '~> 3.13'
-  spec.add_development_dependency 'rubocop', '~> 1.63'
+  spec.add_development_dependency 'rubocop', '~> 1.66'
   spec.add_development_dependency 'simplecov', '~> 0.22'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
+  spec.add_development_dependency 'simplecov-rspec', '~> 0.2'
   spec.add_development_dependency 'timecop', '~> 0.9'
-  spec.add_development_dependency 'yard', '~> 0.9'
-  spec.add_development_dependency 'yardstick', '~> 0.9'
 
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  unless RUBY_PLATFORM == 'java'
+    spec.add_development_dependency 'redcarpet', '~> 3.6'
+    spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.28'
+    spec.add_development_dependency 'yardstick', '~> 0.9'
+  end
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

create_github_release.gemspec

@@ -28,7 +28,7 @@
 
       let(:mocked_commands) do
         [
-          MockedCommand.new('bundle update --quiet', exitstatus: exitstatus)
+          MockedCommand.new('bundle update --quiet', exitstatus:)
         ]
       end
 
@@ -55,7 +55,7 @@
 
       let(:mocked_commands) do
         [
-          MockedCommand.new('bundle install --quiet', exitstatus: exitstatus)
+          MockedCommand.new('bundle install --quiet', exitstatus:)
         ]
       end
 

spec/create_github_release/assertions/bundle_is_up_to_date_spec.rb

@@ -23,7 +23,7 @@
 
     let(:mocked_commands) do
       [
-        MockedCommand.new('gh auth status 2>&1', stdout: stdout, exitstatus: exitstatus)
+        MockedCommand.new('gh auth status 2>&1', stdout:, exitstatus:)
       ]
     end
 

spec/create_github_release/assertions/gh_authenticated_spec.rb

@@ -23,7 +23,7 @@
 
     let(:mocked_commands) do
       [
-        MockedCommand.new('which gh > /dev/null 2>&1', exitstatus: exitstatus)
+        MockedCommand.new('which gh > /dev/null 2>&1', exitstatus:)
       ]
     end
 

spec/create_github_release/assertions/gh_command_exists_spec.rb

@@ -23,7 +23,7 @@
 
     let(:mocked_commands) do
       [
-        MockedCommand.new('which git > /dev/null 2>&1', exitstatus: exitstatus)
+        MockedCommand.new('which git > /dev/null 2>&1', exitstatus:)
       ]
     end
 

spec/create_github_release/assertions/git_command_exists_spec.rb

@@ -23,7 +23,7 @@
 
     let(:mocked_commands) do
       [
-        MockedCommand.new('git rev-parse --is-inside-work-tree --quiet > /dev/null 2>&1', exitstatus: exitstatus)
+        MockedCommand.new('git rev-parse --is-inside-work-tree --quiet > /dev/null 2>&1', exitstatus:)
       ]
     end
 

spec/create_github_release/assertions/in_git_repo_spec.rb

@@ -32,12 +32,12 @@
         MockedCommand.new(
           'git rev-parse HEAD',
           stdout: "#{local_commit}\n",
-          exitstatus: exitstatus
+          exitstatus:
         ),
         MockedCommand.new(
           "git ls-remote 'origin' 'default-branch' | cut -f 1",
           stdout: "#{remote_commit}\n",
-          exitstatus: exitstatus
+          exitstatus:
         )
       ]
     end

spec/create_github_release/assertions/local_and_remote_on_same_commit_spec.rb

@@ -47,8 +47,10 @@ def backtick_debug?
         end
       end
 
+      require 'rbconfig'
+
       context 'when the command fails' do
-        let(:command) { 'echo foo; exit 1' }
+        let(:command) { "#{RbConfig.ruby} -e \"puts 'foo'; exit 1\"" }
 
         let(:including_class) do
           Class.new do
@@ -61,7 +63,7 @@ def backtick_debug?
 
         let(:expected_output) { <<~EXPECTED_OUTPUT }
           COMMAND
-            echo foo; exit 1
+            #{command}
           OUTPUT
             foo
           EXITSTATUS

spec/create_github_release/backtick_debug_spec.rb

@@ -8,6 +8,6 @@
   describe '#initialize' do
     subject { change }
 
-    it { is_expected.to(have_attributes(sha: sha, subject: subject_string)) }
+    it { is_expected.to(have_attributes(sha:, subject: subject_string)) }
   end
 end

spec/create_github_release/change_spec.rb

@@ -21,8 +21,8 @@
     it do
       is_expected.to(
         have_attributes(
-          existing_changelog: existing_changelog,
-          next_release_description: next_release_description
+          existing_changelog:,
+          next_release_description:
         )
       )
     end