kover-report

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #golang #go #machine-learning #deep-learning #docker #java #cli #kubernetes #awesome-list #openai #open-source

(★ 77)

Github action that publishes the Kover code coverage report as a comment in pull requests

kover-report Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# kover-report

[![Tests](https://github.com/mi-kas/kover-report/actions/workflows/test.yml/badge.svg)](https://github.com/mi-kas/kover-report/actions/workflows/test.yml) [![GitHub License](https://img.shields.io/github/license/mi-kas/kover-report?label=License)](https://github.com/mi-kas/kover-report/blob/main/LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://raw.githubusercontent.com/mi-kas/kover-report/main/code_of_conduct.md)

A Github action that publishes the [Kover](https://github.com/Kotlin/kotlinx-kover) code coverage report as a comment in pull requests. The comment shows overall project coverage and per-file coverage for files changed in the compared commit range.

## Usage

### Pre-requisites

Create a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).

### Inputs

- `path` - [**required** string[]] List of paths or glob patterns to the generated kover report xml files
- `token` - [*optional* string] GitHub personal token to add commits to the pull request
- `title` - [*optional* string] Title for the pull request comment
- `update-comment` - [*optional* boolean (default: `false`)] Update the coverage report comment instead of creating a new one. Requires `title` to be set.
- `min-coverage-overall` - [*optional* integer] The minimum code coverage that is required to pass for overall project
- `min-coverage-changed-files` - [*optional* integer] The minimum code coverage that is required to pass for changed files
- `coverage-counter-type` - [*optional* string (default: `LINE`)] Report counter type used to calculate coverage metrics. Possible values are: `INSTRUCTION`, `LINE` or `BRANCH`.
- `upload_url` - [*optional* string] Full URL of the upload service endpoint that receives coverage XML reports. Must be set together with `upload_token`.
- `upload_token` - [*optional* string] Bearer token used to authenticate coverage XML report uploads. Must be set together with `upload_url`.

### Outputs

- `coverage-overall` - [integer] The overall coverage of the project
- `coverage-changed-files` - [integer] The total coverage of all changed files

### Example Workflow

```yaml
name: Measure coverage

on:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - uses: actions/checkout@v6
      - name: Set up JDK
        uses: actions/setup-java@v5
        with:
          distribution: 'temurin'
          java-version: '21'
      - name: Set up Gradle
        uses: gradle/actions/setup-gradle@v6
      - name: Generate kover coverage report
        run: ./gradlew koverXmlReport

- name: Add coverage report to PR
        id: kover
        uses: mi-kas/kover-report@v2
        with:
          path: |
            ${{ github.workspace }}/project1/build/reports/kover/report.xml
            ${{ github.workspace }}/project2/build/reports/kover/report.xml
          title: Code Coverage
          update-comment: true
          min-coverage-overall: 80
          min-coverage-changed-files: 80
          coverage-counter-type: LINE
          upload_url: https://coverage.example.com/api/v1/reports/upload
          upload_token: ${{ secrets.COVERAGE_UPLOAD_TOKEN }}
```

Glob patterns are also supported for `path`, for example:

```yaml
          path: |
            ${{ github.workspace }}/**/reports/kover/report.xml
```

Each `path` entry is resolved independently. If a glob matches multiple XML
files, all of them are included in the report. If an entry does not match
anything, it is still treated as a literal path so the action keeps the
existing missing-file behavior instead of silently skipping it.

When both `upload_url` and `upload_token` are provided, each resolved XML
report is also uploaded with a multipart `POST` request directly to
`upload_url`. The request includes repository, branch, commit SHA, commit
timestamp, commit author, commit subject, and the XML file.

## Limitations

The pull request comment does not render every class or source file from the XML report. It only lists coverage for files detected as changed between the compared commits, alongside the total project coverage row.

GitHub restricts the maximum permissions to read-only for personal access tokens for pull requests originating from a public forked repository (read more [here](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)). This prevents the default configuration of this action from successfully posting the report as a PR comment when using it on public repositories with limited permissions for users to create branches and therefore requiring them to create pull requests from forks.

## Code of Conduct

Please read the [full Code of Conduct](CODE_OF_CONDUCT.md) so that you can understand what we expect project participants to adhere to and what actions will and will not be tolerated.

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE).

kover-report

kover-report Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

kover-report

kover-report Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README