https://github.com/duyet/cov-rs

Rust Source-based Code Coverage for any projects
https://github.com/duyet/cov-rs

bash codecov github-actions rust rust-lang

Last synced: about 1 year ago
JSON representation

Rust Source-based Code Coverage for any projects

• Host: GitHub
• URL: https://github.com/duyet/cov-rs
• Owner: duyet
• License: mit
• Created: 2022-04-09T16:10:16.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-19T11:00:43.000Z (over 2 years ago)
• Last Synced: 2025-03-28T02:45:29.578Z (about 1 year ago)
• Topics: bash, codecov, github-actions, rust, rust-lang
• Language: Shell
• Homepage:
• Size: 278 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Rust Source-based Code Coverage

[![Test](https://github.com/duyet/cov-rs/actions/workflows/test.yaml/badge.svg)](https://github.com/duyet/cov-rs/actions/workflows/test.yaml)

A source-based code coverage enabled with `-C instrument-coverage`, 

which uses LLVM's native, efficient coverage instrumentation to generate very precise coverage data.

# Usage

```bash

bash <(curl -s https://raw.githubusercontent.com/duyet/cov-rs/master/cov.sh)

```

# Github Workflows

See [.github/workflows/test.yaml](.github/workflows/test.yaml) for example

```yaml

on:

  push:

    branches: [master]

  pull_request:

    branches: [master]

jobs:

  build:

    runs-on: ${{ matrix.os }}

    strategy:

      matrix:

        os: [ubuntu-latest, macos-latest]

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Rust Toolchain

        uses: actions-rs/toolchain@v1

        with:

          toolchain: stable

      - name: Code Coverage

        env:

          GITHUB_PULL_REQUEST: ${{ github.event.pull_request.number }}

        run: |

          export GITHUB_PULL_REQUEST=${{ env.GITHUB_PULL_REQUEST }}

          export GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}

          export PROJECT_TITLE="Example build on ${{ matrix.os }}"

          cd example && bash <(curl -s https://raw.githubusercontent.com/duyet/cov-rs/master/cov.sh)

```

The coverage report will be shown at Github Actions [logs](https://github.com/duyet/cov-rs/runs/5959116619?check_suite_focus=true).

![](.github/cov-log.png)

## Comment on Github pull requests

If you set the `GITHUB_PULL_REQUEST`, `GITHUB_TOKEN` 

and `PROJECT_TITLE` (optional), the coverage script will comment the cov report on PR, for example: 

https://github.com/duyet/cov-rs/pull/3#issuecomment-1094174485

![](.github/cov-comment.png)

# License

MIT