Skip to content
This repository has been archived by the owner on Oct 13, 2023. It is now read-only.
/ tarpaulin Public archive

๐Ÿ“ˆ GitHub Action for code coverage reporting with tarpaulin

License

Notifications You must be signed in to change notification settings

actions-rs/tarpaulin

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

10 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Rust tarpaulin Action

MIT licensed Gitter

This GitHub Action installs and runs cargo-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

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.

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