RSpec formatter compatible with GitHub Action's annotations. It supports multiline errors and will set pending specs as warnings:
Add the gem to your application's Gemfile
test
group:
group :test do
gem 'rspec-github', git: 'https://github.com/RideRoundTrip/rspec-github', branch: 'main', require: false
end
And then of course install the gem by executing:
bundle install
You can specify the formatter with a command line argument:
rspec --format RSpec::Github::Formatter
And to always run it with this formatter, you can set it in the .rspec
file:
# other configuration
--format RSpec::Github::Formatter
Note that you can select multiple formatters so that you can also see other output:
rspec --format RSpec::Github::Formatter --format progress
rspec --format RSpec::Github::Formatter --format documentation
If you want to disable annotations for pending specs you can do that by adding --tag ~skip
to your command:
rspec --format RSpec::Github::Formatter --tag ~skip
After checking out the repo, run bundle install
to install dependencies. Then, run rake spec
to run the tests.