code-coverage-action

GitHub Action that generates coverage reports

Installation

1. Install Barecheck Application
2. Copy the token provided on the authorization confirmation page and add it to your build environment as BARECHECK_GITHUB_APP_TOKEN
3. 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.
workspace-path	no	'Barecheck'	Option to specify the path of projects in monorepo
pull-number	no	''	Pull request number where code coverage comment will be send. This arg mostly is for 'push' events workflows.

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@v3
        with:
          ref: ${{ github.base_ref }}
      - name: Use Node.js v20.9.0
        uses: actions/setup-node@v3
        with:
          node-version: v20.9.0

      - name: Install dependencies
        run: yarn

      - name: Run test coverage
        run: yarn coverage

      - name: Upload code coverage for ref branch
        uses: actions/upload-artifact@v3
        with:
          name: ref-lcov.info
          path: ./coverage/lcov.info

  checks:
    runs-on: ubuntu-latest
    needs: base_branch_cov
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js v20.9.0
        uses: actions/setup-node@v3
        with:
          node-version: v20.9.0

      - name: Download code coverage report from base branch
        uses: actions/download-artifact@v3
        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|error

Use 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"
    workspace-path: "apps/application1"

- 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"
    workspace-path: "apps/application2"

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.

'Push' events support

If your workflows are using 'push' events but you still would like to receive barecheck code coverage comments in your Pull requests, there is a handy pull-number input that can be used. This input would be used as Pull request number where the comments need to be posted.

Here are also handy actions that you can use to fetch an associated Pull request number for every 'push' event.

• https://github.com/marketplace/actions/find-current-pull-request
• https://github.com/marketplace/actions/find-pull-request

# Find the PR associated with this push, if there is one.
- uses: jwalton/gh-find-current-pr@master
  id: findPr
  with:
    # Can be "open", "closed", or "all".  Defaults to "open".
    state: open

- name: Generate Code Coverage report
  id: code-coverage
  if: success() && steps.findPr.outputs.number
  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"
    pull-number: ${{ steps.findPr.outputs.number }}

Contributing

👋 Welcome, new contributors!

Whether you're a seasoned developer or just getting started, your contributions are valuable to us. Don't hesitate to jump in, explore the project, and make an impact. To start contributing, please check out our Contribution Guidelines.

Cycle time (Last 30 days)

---

^{_{Check also our Public Dashboard powered by devActivity}}

Repo Stats (last 45 days)

---

^{_{Check also our Public Dashboard powered by devActivity}}

Setup development environment

• Clone this repository
• Use current node.js version nvm use or nvm install
• Run yarn install
• Develop feature/fix
• Run yarn build
• Commit changes including ./dist/index.js bundle
• Create Pull request