scoverage:check

Full name:

org.scoverage:scoverage-maven-plugin:2.0.5:check

Description:

Checks if minimum code coverage by unit tests reached in forked scoverage life cycle.

In forked scoverage life cycle project is compiled with SCoverage instrumentation and unit tests are executed before checking.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 1.0.0.
  • Invokes the execution of the following lifecycle phase prior to executing itself: test.
  • Executes in its own lifecycle: scoverage.

Optional Parameters

Name Type Since Description
<encoding> String 1.4.12 The file encoding to use when reading Scala sources.

Default: ${project.build.sourceEncoding}
User Property: encoding
<failOnMinimumCoverage> boolean 1.0.0 Fail the build if minimum coverage was not reached.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.

Default: false
User Property: scoverage.failOnMinimumCoverage
<minimumCoverage> Double 1.0.0 Required minimum total statement coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.

Default: 0
User Property: scoverage.minimumCoverage
<minimumCoverageBranchPerFile> Double 2.0.1 Required minimum per-file branch coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.

Default: 0
User Property: scoverage.minimumCoverageBranchPerFile
<minimumCoverageBranchPerPackage> Double 2.0.1 Required minimum per-package branch coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.

Default: 0
User Property: scoverage.minimumCoverageBranchPerPackage
<minimumCoverageBranchTotal> Double 2.0.1 Required minimum total branch coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.

Default: 0
User Property: scoverage.minimumCoverageBranchTotal
<minimumCoverageStmtPerFile> Double 2.0.1 Required minimum per-file statement coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.

Default: 0
User Property: scoverage.minimumCoverageStmtPerFile
<minimumCoverageStmtPerPackage> Double 2.0.1 Required minimum per-package statement coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.

Default: 0
User Property: scoverage.minimumCoverageStmtPerPackage
<skip> boolean 1.0.0 Allows SCoverage to be skipped.

Default: false
User Property: scoverage.skip

Parameter Details

<encoding>

The file encoding to use when reading Scala sources.
  • Type: java.lang.String
  • Since: 1.4.12
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

<failOnMinimumCoverage>

Fail the build if minimum coverage was not reached.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: scoverage.failOnMinimumCoverage
  • Default: false

<minimumCoverage>

Required minimum total statement coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.
  • Type: java.lang.Double
  • Since: 1.0.0
  • Required: No
  • User Property: scoverage.minimumCoverage
  • Default: 0

<minimumCoverageBranchPerFile>

Required minimum per-file branch coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.
  • Type: java.lang.Double
  • Since: 2.0.1
  • Required: No
  • User Property: scoverage.minimumCoverageBranchPerFile
  • Default: 0

<minimumCoverageBranchPerPackage>

Required minimum per-package branch coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.
  • Type: java.lang.Double
  • Since: 2.0.1
  • Required: No
  • User Property: scoverage.minimumCoverageBranchPerPackage
  • Default: 0

<minimumCoverageBranchTotal>

Required minimum total branch coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.
  • Type: java.lang.Double
  • Since: 2.0.1
  • Required: No
  • User Property: scoverage.minimumCoverageBranchTotal
  • Default: 0

<minimumCoverageStmtPerFile>

Required minimum per-file statement coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.
  • Type: java.lang.Double
  • Since: 2.0.1
  • Required: No
  • User Property: scoverage.minimumCoverageStmtPerFile
  • Default: 0

<minimumCoverageStmtPerPackage>

Required minimum per-package statement coverage.

See https://github.com/scoverage/sbt-scoverage#minimum-coverage for additional documentation.
  • Type: java.lang.Double
  • Since: 2.0.1
  • Required: No
  • User Property: scoverage.minimumCoverageStmtPerPackage
  • Default: 0

<skip>

Allows SCoverage to be skipped.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: scoverage.skip
  • Default: false