code-coverage-action
GitHub Action that generates coverage reports
Installation
- Install Barecheck Application
- Copy the token provided on the authorization confirmation page and add it to your build environment as BARECHECK_GITHUB_APP_TOKEN
- Create Github Actions workflow from the example
Features
Show annotations
As a part of code coverage report action also enable an ability to show annotations along with changed lines to keep control of what is covered with tests without interacting review process
Show uncovered files
In the real; world, it's hard to get 100% code coverage and keep it all the time. Instead of showing you all uncovered files Barecheck show only the ones you have changed.
Usage
To integrate with this Github Action, you can just use the following configuration in your already created workflow. As a result, you will get Github Pull request comment with total code coverage
- name: Generate Code Coverage report
id: code-coverage
uses: barecheck/code-coverage-action@v1
with:
barecheck-github-app-token: ${{ secrets.BARECHECK_GITHUB_APP_TOKEN }}
lcov-file: "./coverage/lcov.info"
base-lcov-file: "./coverage/base-lcov.info"
send-summary-comment: true
show-annotations: "warning"Arguments
Inputs
| Key | Required | Default | Description |
|---|---|---|---|
github-token |
yes | - | Default Github Actions token. The token is not required if GitHub application is installed and the token passed through barecheck-github-app-token |
lcov-file |
yes | - | Lcov.info file that was generated after your test coverage command |
barecheck-github-app-token |
no | - | Barecheck application token, received after application installation comment. |
barecheck-api-key |
no | - | Your project API_KEY generated from https://barecheck.com. Use this property to avoid running coverage for the base branch. |
base-lcov-file |
no | - | Lcov.info file that would be used to compare code coverage. The comparison will be disabled if the file is not passed |
send-summary-comment |
no | true | Option to send Github code coverage comment based on the changes that were made in PR |
show-annotations |
no | 'warning' | Option to enable Github annotation that would show uncovered files in review tab. Options: ' ' | warning | error |
minimum-ratio |
no | '' | Percentage of uncovered lines that are allowed for new changes |
app-name |
no | 'Barecheck' | Application name would be used once you have more than one report in your workflow and want to have different reports per application. |
Workflow Example
In order to compare your new changes report and the base branch you are able to use Github artifacts as in the example below:
name: Code Coverage
on: [pull_request]
jobs:
base_branch_cov:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: ${{ github.base_ref }}
- name: Use Node.js v16.11.0
uses: actions/setup-node@v1
with:
node-version: v16.11.0
- name: Install dependencies
run: yarn
- name: Run test coverage
run: yarn coverage
- name: Upload code coverage for ref branch
uses: actions/upload-artifact@v2
with:
name: ref-lcov.info
path: ./coverage/lcov.info
checks:
runs-on: ubuntu-latest
needs: base_branch_cov
steps:
- uses: actions/checkout@v2
- name: Use Node.js v16.11.0
uses: actions/setup-node@v1
with:
node-version: v16.11.0
- name: Download code coverage report from base branch
uses: actions/download-artifact@v2
with:
name: ref-lcov.info
- name: Install dependencies
run: yarn
- name: Run test coverage
run: yarn coverage
# Compares two code coverage files and generates report as a comment
- name: Generate Code Coverage report
id: code-coverage
uses: barecheck/code-coverage-action@v1
with:
barecheck-github-app-token: ${{ secrets.BARECHECK_GITHUB_APP_TOKEN }}
lcov-file: "./coverage/lcov.info"
base-lcov-file: "./lcov.info"
minimum-ratio: 0 # Fails Github action once code coverage is decreasing
send-summary-comment: true
show-annotations: "warning" # Possible options warning|errorUse cases
Monorepo support
If you have monorepo with more than one application and want to have different code coverage reports you can use app-name input property to define different application names that would be used as a part of the title.
- name: Application1 - Generate Code Coverage report
id: code-coverage
uses: barecheck/code-coverage-action@v1
with:
barecheck-github-app-token: ${{ secrets.BARECHECK_GITHUB_APP_TOKEN }}
lcov-file: "./coverage/lcov.info"
base-lcov-file: "./coverage/base-lcov.info"
app-name: "Application 1"- name: Application2 - Generate Code Coverage report
id: code-coverage
uses: barecheck/code-coverage-action@v1
with:
barecheck-github-app-token: ${{ secrets.BARECHECK_GITHUB_APP_TOKEN }}
lcov-file: "./coverage/lcov.info"
base-lcov-file: "./coverage/base-lcov.info"
app-name: "Application 2"Using Barecheck Cloud
Barecheck cloud is still in beta but there are already some numbers of teams that are using it. Especially, for complex projects where running coverage for the main branch twice just to compare results might lead to performance problems. Action will not send any data besides just the coverage number and commit sha to the cloud so you can securely use this feature.
- name: Generate Code Coverage report
id: code-coverage
uses: barecheck/code-coverage-action@v1
with:
barecheck-github-app-token: ${{ secrets.BARECHECK_GITHUB_APP_TOKEN }}
barecheck-api-key: ${{ secrets.BARECHECK_API_KEY }}
lcov-file: "./coverage/lcov.info"barecheck-api-key has a bigger priority than base-lcov-file . Once you passed of them, only API KEY will be used. All other parameters can be used in the same way.
Contributing
- Clone this repository
- Use current node.js version
nvm useornvm install - Run
yarn install - Develop feature/fix
- Run
yarn build - Commit changes including
./dist/index.jsbundle - Create Pull request