https://github.com/joshmfrankel/simplecov-check-action
SimpleCov+ Action
https://github.com/joshmfrankel/simplecov-check-action
coverage ruby
Last synced: 5 months ago
JSON representation
SimpleCov+ Action
- Host: GitHub
- URL: https://github.com/joshmfrankel/simplecov-check-action
- Owner: joshmfrankel
- License: mit
- Created: 2022-02-18T18:41:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-17T18:55:42.000Z (9 months ago)
- Last Synced: 2025-10-26T13:37:06.900Z (8 months ago)
- Topics: coverage, ruby
- Language: Ruby
- Homepage:
- Size: 211 KB
- Stars: 45
- Watchers: 1
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SimpleCov+ Action
A Github check action which displays failing test coverage from SimpleCov while providing the option
to fail a build based on minimum coverage threshold.
Want to see more examples of this check in action? :wink: See [screenshots.md](/screenshots.md)
## Basic Installation
In order for SimpleCov+ Action to function properly, you first need the simplecov gem. See [Getting Started](https://github.com/simplecov-ruby/simplecov#getting-started).
Assuming you've followed the guide above (you have the gem in your Gemfile and have properly setup test_helper.rb), then the only other step is to utilize the Github action within your workflow.
```yml
# However you run your tests to generate code coverage
- name: Run my tests
run: |
bundle exec rspec specs/
# Minimum configuration
- uses: joshmfrankel/simplecov-check-action@main
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
```
## Configuration Options
See [https://github.com/joshmfrankel/simplecov-check-action/blob/main/action.yml](https://github.com/joshmfrankel/simplecov-check-action/blob/main/action.yml) for all available options and their defaults.
Most useful is the **minimum_suite_coverage** option as it allows specification as to the value at which a failure result should be produced.
## Advanced Installation
The advanced installation switches the coverage failing mode from **overall test coverage** to **per file coverage**. This is similiar to the `minimum_coverage_by_file` option that SimpleCov provides. See [minimum_coverage_by_file](https://github.com/simplecov-ruby/simplecov#minimum-coverage-by-file)
In order to activate advanced mode, you'll need to configure the simplecov-json gem. See [Usage](https://github.com/vicentllongo/simplecov-json#usage) for simplecov-json.
You'll need to setup both the standard formatter as well as json formatter within your test_helper.rb. Example below:
```ruby
require "simplecov"
require "simplecov-json"
SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
SimpleCov::Formatter::HTMLFormatter,
SimpleCov::Formatter::JSONFormatter
])
SimpleCov.start do
# your config
end
```
One large benefit to this approach is that your code coverage minimum threshold is less skewed by outlier results. Said best by the SimpleCov documentation:
> You can define the minimum coverage by file percentage expected... This is useful to help ensure coverage is relatively consistent, rather than being skewed by particularly good or bad areas of the code.
## Example configuration
Still struggling to set this up? SimpleCov+ Action utilizes itself within a Github workflow. You can view the workflow and the spec_helper files for a good example of how to configure this check.
[Example Github Workflow](/.github/workflows/testing.yml)
[Example Spec Helper SimpleCov Setup](/specs/spec_helper.rb)
## FAQs
First off there is a `debug` option which prints many of the API calls made to Github. This can be helpful for diagnosing faults in SimpleCov+ Action.
### I don't want to fail coverage on a per-file basis
If you've configured SimpleCov-json then SimpleCov+ Action will automatically
fail CI when any file is below the minimum file coverage. This can be disabled if
you want to utilize SimpleCov-json but don't want SimpleCov+ Action to fail by
setting `minimum_file_coverage` to 0.
### My Code Coverage isn't accurate for Rails parallelize
Use the following configuration within your test_helper.rb or spec_helper.rb:
```ruby
# inside test_helper.rb or spec_helper.rb
class ActiveSupport::TestCase
parallelize(workers: :number_of_processors)
parallelize_setup do |worker|
SimpleCov.command_name "#{SimpleCov.command_name}-#{worker}"
end
parallelize_teardown do
SimpleCov.result
end
end
```
Additionally, make sure that your test environment is eager loading your application. This ensures that SimpleCov picks up coverage for all files accurately.
```ruby
# config/environments/test.rb
Rails.application.configure do
# many more configs...
# Note: ENV["CI"] is set to true by default from Github in the testing environment
config.eager_load = ENV["CI"].present?
# some more configs...
end
```
## Development Setup
```bash
git clone git@github.com:joshmfrankel/simplecov-check-action.git
cd simplecov-check-action
bundle install
bundle exec rspec specs
```