https://github.com/codecov/example-scala

Scala coverage example
https://github.com/codecov/example-scala

coverage scala scoverage

Last synced: about 2 months ago
JSON representation

Scala coverage example

• Host: GitHub
• URL: https://github.com/codecov/example-scala
• Owner: codecov
• License: mit
• Created: 2014-09-22T14:00:30.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-03-25T18:29:31.000Z (10 months ago)
• Last Synced: 2024-04-16T04:50:12.343Z (9 months ago)
• Topics: coverage, scala, scoverage
• Language: Scala
• Homepage: https://codecov.io/
• Size: 63.5 KB
• Stars: 35
• Watchers: 14
• Forks: 23
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# [Codecov](https://codecov.io) Scala Example

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fexample-scala.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fexample-scala?ref=badge_shield)

## Guide

### GitHub Actions Setup

You should first get the repository upload token from [codecov](https://docs.codecov.com/docs/quick-start#step-2-get-the-repository-upload-token)

Add the following to your `.github/workflows/test.yml` file. 

```yml

name: Test workflow

on: [push, pull_request]

jobs:

  build:

    runs-on: ubuntu-latest

    name: Test scala

    steps:

      - uses: actions/checkout@v4

      - uses: actions/setup-java@v4

        with:

          distribution: 'adopt'

          java-version: '21'

      - name: Run tests

        run: sbt coverage test coverageReport

      - uses: codecov/codecov-action@v4

        with:

          fail_ci_if_error: true

          token: ${{ secrets.CODECOV_TOKEN }}

```

Here we frist checkout the code, then setup java, run the tests and generate the coverage report. Finally, we upload the report to codecov using the codecov-action.

When all finished, you could also add a badge on readme like following.

```

[![codecov](https://codecov.io/gh/YOUR_ACCOUNT/YOUR_REPO/branch/YOUR_BRANCH/graph/badge.svg)](https://codecov.io/gh/YOUR_ACCOUNT/YOUR_REPO)

```

### Produce Coverage Reports

1. Add `scoverage` to plugin list

  - `addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.0.11")` as [seen here](https://github.com/codecov/example-scala/blob/master/project/plugins.sbt#L1)

1. Add `coverage` and `coverageReport` to `sbt`

  - `sbt clean coverage test coverageReport` as [seen here](https://github.com/codecov/example-scala/blob/master/.travis.yml#L7)

## Caveats

### Private Repo

Repository tokens are required for 

- (a) all private repos, 

- (b) public repos not using Travis-CI, CircleCI or AppVeyor. 

Find your repository token at Codecov and provide via appending `-t ` to you where you upload reports.

## Links

- [Community Boards](https://community.codecov.io)

- [Support](https://codecov.io/support)

- [Documentation](https://docs.codecov.io)

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fexample-scala.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fexample-scala?ref=badge_large)