Merge pull request #6348 from tvdeyen/rspec-github-formatter

feat(CI): Use rspec-github formatter

Author: tvdeyen

.github/workflows/test_solidus.yml

@@ -98,7 +98,7 @@ jobs:
         run: |
           cd ${{ inputs.lib_name }}
           bundle exec rake test_app
-          bundle exec rspec --profile 10 --format progress
+          bundle exec rspec --profile 10 --format progress --format RSpec::Github::Formatter
       - name: Upload coverage report to Codecov
         uses: codecov/codecov-action@v5
         if: ${{ steps.setup-coverage.outputs.coverage == 'true' }}

Gemfile

@@ -36,6 +36,10 @@ gem 'rspec_junit_formatter', require: false
 gem 'yard', require: false
 gem 'db-query-matchers', require: false
 
+if ENV['GITHUB_ACTIONS']
+  gem "rspec-github", "~> 3.0", require: false
+end
+
 # Ensure the requirement is also updated in core/lib/spree/testing_support/factory_bot.rb
 gem 'factory_bot_rails', '>= 4.8', require: false
 

admin/spec/spec_helper.rb

@@ -87,6 +87,11 @@
 end
 
 RSpec.configure do |config|
+  if ENV["GITHUB_ACTIONS"]
+    require "rspec/github"
+    config.add_formatter RSpec::Github::Formatter
+  end
+
   config.color = true
   config.infer_spec_type_from_file_location!
   config.expect_with :rspec do |c|

api/spec/spec_helper.rb

@@ -48,6 +48,11 @@
 Spree::TestingSupport::FactoryBot.add_paths_and_load!
 
 RSpec.configure do |config|
+  if ENV["GITHUB_ACTIONS"]
+    require "rspec/github"
+    config.add_formatter RSpec::Github::Formatter
+  end
+
   config.backtrace_exclusion_patterns = [/gems\/activesupport/, /gems\/actionpack/, /gems\/rspec/]
   config.color = true
   config.infer_spec_type_from_file_location!

backend/spec/spec_helper.rb

@@ -65,6 +65,11 @@
 Spree::TestingSupport::FactoryBot.add_paths_and_load!
 
 RSpec.configure do |config|
+  if ENV["GITHUB_ACTIONS"]
+    require "rspec/github"
+    config.add_formatter RSpec::Github::Formatter
+  end
+
   config.color = true
   config.infer_spec_type_from_file_location!
   config.expect_with :rspec do |c|

core/spec/spec_helper.rb

@@ -24,6 +24,11 @@
 require 'spree/config'
 
 RSpec.configure do |config|
+  if ENV["GITHUB_ACTIONS"]
+    require "rspec/github"
+    config.add_formatter RSpec::Github::Formatter
+  end
+
   config.disable_monkey_patching!
   config.color = true
   config.expect_with :rspec do |c|

legacy_promotions/spec/spec_helper.rb

@@ -26,6 +26,11 @@
 require "solidus_legacy_promotions"
 
 RSpec.configure do |config|
+  if ENV["GITHUB_ACTIONS"]
+    require "rspec/github"
+    config.add_formatter RSpec::Github::Formatter
+  end
+
   config.disable_monkey_patching!
   config.color = true
   config.expect_with :rspec do |c|

promotions/spec/spec_helper.rb

@@ -29,6 +29,11 @@
 Spree::Config.promotions = SolidusPromotions.configuration
 
 RSpec.configure do |config|
+  if ENV["GITHUB_ACTIONS"]
+    require "rspec/github"
+    config.add_formatter RSpec::Github::Formatter
+  end
+
   config.disable_monkey_patching!
   config.color = true
   config.expect_with :rspec do |c|

sample/spec/spec_helper.rb

@@ -15,6 +15,11 @@
 require 'database_cleaner'
 
 RSpec.configure do |config|
+  if ENV["GITHUB_ACTIONS"]
+    require "rspec/github"
+    config.add_formatter RSpec::Github::Formatter
+  end
+
   config.color = true
   config.infer_spec_type_from_file_location!
   config.expect_with :rspec do |c|