GitHub Action
SimpleCov resultset difference
Creates a comment inside your Pull-Request with the difference between two SimpleCov resultset files.
To use this Github action, in your steps you may have:
uses: kzkn/simplecov-resultset-diff-action@v1
with:
base-resultset-path: '/path/to/my/.resultset.json'
head-resultset-path: '/path/to/my/.resultset.json'
token: ${{ secrets.GITHUB_TOKEN }}| Inputs | Required | Default | Description |
|---|---|---|---|
| base-stats-path | true | Path to the SimpleCov generated ".resultset.json" file from the base branch. | |
| head-stats-path | true | Path to the SimpleCov generated "resultset.json" file from the head branch. | |
| token | true | Github token so the package can publish a comment in the pull-request when the diff is ready. |
If you want to compare the coverage difference between your base branch and your pull-request head branch.
You'll need to run your test and collect coverage for the head branch:
on:
pull_request:
jobs:
build-head:
name: 'Build head'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
- name: Run test
run: bundle exec rspecThen we will use the Github Actions feature called "artifacts" to store that .resultset.json file.
- name: Upload coverage report
if: always()
uses: actions/upload-artifact@v2
with:
name: head-result
path: coverage/.resultset.jsonNow you can do the exact same thing, but for the base branch. Note the checkout step!
build-base:
name: 'Build base'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
## Here we do not checkout the current branch, but we checkout the base branch.
ref: ${{ github.base_ref }}
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
- name: Run test
run: bundle exec rspec
- name: Upload coverage report
if: always()
uses: actions/upload-artifact@v2
with:
name: base-result
path: coverage/.resultset.jsonNow, in a new job we can retrieve both of our saved resultset from the artifacts and use this action to compare them.
compare:
name: 'Compare base & head coverages'
runs-on: ubuntu-latest
needs: [build-base, build-head]
steps:
- name: Download base artifact
uses: actions/download-artifact@v1
with:
name: base-result
- name: Download head artifact
uses: actions/download-artifact@v1
with:
name: head-result
- uses: kzkn/simplecov-resultset-diff-action@v1
with:
base-resultset-path: ./base-result/.resultset.json
head-resultset-path: ./head-result/.resultset.json
token: ${{ secrets.GITHUB_TOKEN }}That's it! When the compare job will be executed, it will post a comment in the current pull-request with the difference between the two resultset files.
You can use the cached resultset file for comparison. To cache the resultset file that generated from the build-base job, it will save the build time.
build-base:
name: 'Build base'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: ${{ github.base_ref }}
- id: base-ref-commit
run: echo "::set-output name=revision::`git rev-parse HEAD`"
- name: simplecov resultset cache
id: simplecov-resultset
uses: actions/cache@v2
with:
path: coverage/.resultset.json
key: simplecov-resultset-${{ steps.base-ref-commit.outputs.revision }}
- uses: ruby/setup-ruby@v1
if: steps.simplecov-resultset.outputs.cache-hit != 'true'
with:
bundler-cache: true
- name: Run test
if: steps.simplecov-resultset.outputs.cache-hit != 'true'
run: bundle exec rspec
- name: Upload coverage report
if: always()
uses: actions/upload-artifact@v2
with:
name: base-result
path: coverage/.resultset.jsonMIT