Skip to content

Commit

Permalink
Add about diff:
Browse files Browse the repository at this point in the history
  • Loading branch information
k1LoW committed Sep 22, 2021
1 parent 62e3fea commit 3f536a7
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,18 @@ codeToTestRatio:
- '**/*_test.go'
```

By setting `diff:` ( `diff.path:` or `diff.datastores` ) additionally, it is possible to show differences from previous reports as well.

``` yaml
comment:
enable: true
diff:
datastores:
- s3://bucket/reports
```

![img](docs/coverage_with_diff.png)

### Check for acceptable score

By setting `coverage.acceptable:`, the minimum acceptable coverage is specified.
Expand Down Expand Up @@ -349,13 +361,42 @@ comment:
hideFooterLink: true
```

### `diff:`

Configuration for comparing reports.

### `diff.path:`

Path of the report to compare.

``` yaml
diff:
path: path/to/coverage.yml
```

``` yaml
diff:
path: .octocov/owner/repo/report.json
```

### `diff.datastores:`

Datastores where the report to be compared is stored.

``` yaml
diff:
datastores:
- local://.octocov # Use .octocov/owner/repo/report.json
- s3://my-bucket/reports # Use s3://my-bucket/reports/owner/repo/report.json
```

### `report:`

Configuration for reporting to datastores.

### `report.datastores:`

The datastores where the reports are saved.
Datastores where the reports are saved.

``` yaml
report:
Expand Down
Binary file added docs/comment_with_diff.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3f536a7

Please sign in to comment.