https://github.com/actions-rs/tarpaulin

📈 GitHub Action for code coverage reporting with tarpaulin
https://github.com/actions-rs/tarpaulin

code-coverage coverage github github-actions rust rust-lang tarpaulin

Last synced: about 1 month ago
JSON representation

📈 GitHub Action for code coverage reporting with tarpaulin

• Host: GitHub
• URL: https://github.com/actions-rs/tarpaulin
• Owner: actions-rs
• License: mit
• Archived: true
• Created: 2019-09-17T11:13:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-04T11:21:38.000Z (almost 2 years ago)
• Last Synced: 2024-11-03T15:41:47.646Z (about 2 months ago)
• Topics: code-coverage, coverage, github, github-actions, rust, rust-lang, tarpaulin
• Language: TypeScript
• Homepage:
• Size: 909 KB
• Stars: 89
• Watchers: 2
• Forks: 16
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rust `tarpaulin` Action

![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)

[![Gitter](https://badges.gitter.im/actions-rs/community.svg)](https://gitter.im/actions-rs/community)

This GitHub Action installs and runs [cargo-tarpaulin](https://github.com/xd009642/tarpaulin).

It can be used to run tests with coverage tracing enabled, and optionally upload the code coverage reports to coveralls or codecov.

## Example workflow

```yaml

on: [push]

name: build

jobs:

  check:

    name: Rust project

    runs-on: ubuntu-latest

    steps:

      - name: Checkout repository

        uses: actions/checkout@v2

      - name: Install stable toolchain

        uses: actions-rs/toolchain@v1

        with:

          toolchain: stable

          override: true

      - name: Run cargo-tarpaulin

        uses: actions-rs/[email protected]

        with:

          version: '0.15.0'

          args: '-- --test-threads 1'

      - name: Upload to codecov.io

        uses: codecov/[email protected]

        with:

          token: ${{secrets.CODECOV_TOKEN}}

      - name: Archive code coverage results

        uses: actions/upload-artifact@v1

        with:

          name: code-coverage-report

          path: cobertura.xml

```

See [additional recipes here](https://github.com/actions-rs/meta).

## Inputs

| Name        | Required | Description                                                                                              | Type   | Default |

| ------------| :------: | ---------------------------------------------------------------------------------------------------------| ------ | --------|

| `version`   |          | The version of `cargo-tarpaulin` that will be installed.                                                 | string | latest  |

| `run-types` |          | The type of tests to run (`Tests`, or `Doctests`). Runs all by default. May be overridden by `args`.     | string |         |

| `timeout`   |          | The timeout, in seconds, before cancelling execution of a long running test. May be overriden by `args`. | string |         |

| `args`      |          | Extra command line arguments that are passed to `cargo-tarpaulin`.                                       | string |         |

| `out-type`  |          | Output format of coverage report (`Json`, `Toml,`, `Stdout`, `Xml`, `Html`, `Lcov`]. Defaults to `Xml`   | string | Xml     |