Skip to content

docs: Add example for setup with spec_helper.rb #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LuukvH merged 2 commits into from
Mar 23, 2023
Merged

docs: Add example for setup with spec_helper.rb #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e697ad
docs: Add example for setup with spec_helper.rb
nschonni Mar 9, 2023
d63d86d
Merge branch 'master' into spec_helper-exmaple
LuukvH Mar 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,18 @@ And to always run it with this formatter, you can set it in the `.rspec` file:
--format RSpec::Github::Formatter
```

And to register the formatter in configuration, you can add the following to `spec/spec_helper.rb`:

```ruby
RSpec.configure do |config|
# Use the GitHub Annotations formatter for CI
if ENV['GITHUB_ACTIONS'] == 'true'
require 'rspec/github'
config.add_formatter RSpec::Github::Formatter
end
end
```

Note that you can select multiple formatters so that you can also see other output:
```bash
rspec --format RSpec::Github::Formatter --format progress
Expand Down