Sha256: d19c1bae0271fa6ec562eb339799ebec548fcbc94a4201b098f0a3a4a30e6d8a

Contents?: true

Size: 1.25 KB

Versions: 1

Compression:

Stored size: 1.25 KB

Contents

# danger-kover

A danger plugin for enforcing code coverage coverage based on a Kover coverage report.

![Sample Banner Image](images/bannerImage.png)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'danger-kover'
```

## Danger Kover Plugin Usage 

It depends on having a Kover coverage report generated for your project. 

For Android projects, [kotlinx-kover](https://github.com/Kotlin/kotlinx-kover) works well. 

Running with default values:

```ruby
# Report coverage of modified files. 
# Fail if either total project coverage or any modified file's coverage is under 70%.
kover.report 'Module Name', 'path/to/kover/report.xml'
```

Running with custom attributes:

- Fail if total project coverage is under 70%.
- Or if any modified file's coverage is under 80%.

```ruby
kover.total_threshold = 70
kover.file_threshold = 80
kover.report 'Module Name', 'path/to/kover/report.xml'
```

Optional attribute to only warn instead of failing if below thresholds:

```ruby
kover.fail_if_under_threshold false
```

## Development

1. Clone this repo
2. Run `bundle install` to setup dependencies.
3. Run `bundle exec rake spec` to run the tests.
4. Use `bundle exec guard` to automatically have tests run as you make changes.
5. Make your changes.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
danger-kover-0.0.1 README.md