Merge branch 'main' into master

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/release-drafter.yml

@@ -0,0 +1,4 @@
+template: |
+  ## What’s Changed
+
+  $CHANGES

.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    paths-ignore:
+      - '*.md'
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: [ '8', '11' ]
+
+    steps:
+      - name: checkout the repo
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up JVM
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: ${{ matrix.java }}
+
+      - name: Run tests
+        run: sbt scripted
+
+  formatting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout the repo
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up JVM
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: '8'
+
+      - name: Check Formatting
+        run: sbt scalafmtCheckAll

.github/workflows/release-drafter.yml

@@ -0,0 +1,14 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+    tags: ["*"]
+jobs:
+  publish:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: '11'
+      - run: sbt ci-release
+        env:
+          PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
+          PGP_SECRET: ${{ secrets.PGP_SECRET }}
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}

.scala-steward.conf

@@ -0,0 +1 @@
+updates.ignore = [ { groupId = "org.scala-lang" } ]

.scalafmt.conf

@@ -0,0 +1 @@
+version = "2.7.5"

README.md

@@ -1,32 +1,24 @@
-sbt-scoverage
-========
+# sbt-scoverage
 
-sbt-scoverage is a plugin for SBT that integrates the scoverage code coverage library. Find out more about [scoverage](https://github.com/scoverage/scalac-scoverage-plugin).
-
-Join the [scoverage](http://groups.google.com/group/scala-code-coverage-tool)
-google group for help, bug reports, feature requests, and general
-discussion on scoverage.
-
-[![Build Status](https://travis-ci.org/scoverage/sbt-scoverage.png?branch=master)](https://travis-ci.org/scoverage/sbt-scoverage)
+[![Gitter](https://img.shields.io/gitter/room/scoverage/scoverage.svg)](https://gitter.im/scoverage/scoverage)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.scoverage/sbt-scoverage/badge.svg?kill_cache=1)](https://search.maven.org/artifact/org.scoverage/sbt-scoverage/)
 [![License](http://img.shields.io/:license-Apache%202-red.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
-[<img src="https://img.shields.io/maven-central/v/org.scoverage/sbt-scoverage.svg?label=latest%20release"/>](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22sbt-scoverage%22)
 
-## How to use
+sbt-scoverage is a plugin for sbt that integrates the scoverage code coverage
+library. Find out more about
+[scoverage here](https://github.com/scoverage/scalac-scoverage-plugin).
 
-Make sure your SBT version in project/build.properties:
-```
-sbt.version = 0.13.17
-```
-or
-```
-sbt.version = 1.1.1
-```
+## Setup
 
-Add the plugin in project/plugins.sbt:
+**Requirements**: Requires sbt 1.2.8 or above
+
+In `project/plugins.sbt`:
 ```scala
-addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "x.x.x")
 ```
 
+## Usage
+
 Run the tests with enabled coverage:
 ```
 $ sbt clean coverage test
@@ -37,7 +29,7 @@ $ sbt clean coverage it:test
 ```
 
 To enable coverage directly in your build, use:
-```
+```scala
 coverageEnabled := true
 ```
 
@@ -46,46 +38,40 @@ To generate the coverage reports run
 $ sbt coverageReport
 ```
 
-Coverage reports will be in `target/scoverage-report`. There are HTML and XML reports. The XML is useful if you need to programatically use the results, or if you're writing a tool.
-
-If you're running the coverage reports from within an sbt console session (as
-opposed to one command per sbt launch), then the `coverage` command is sticky. To
-turn it back off when you're done running reports, use the `coverageOff` command or reset `coverageEnabled` with `set coverageEnabled := false`.
-
-Sample project with scoverage in both sbt and maven - [the scoverage samples project](https://github.com/scoverage/sbt-scoverage-samples).
-
-## Notes on upgrading to version 1.3.0
-
-* The object containing the keys has changed from nested to top level so you might need to adjust the import. It's also an auto plugin now, so you might not need the import at all.
-* There is an issue syncing the binary with the sbt-plugin-releases repo, so in the meantime add `resolvers += Resolver.url("scoverage-bintray", url("https://dl.bintray.com/sksamuel/sbt-plugins/"))(Resolver.ivyStylePatterns)` to your build.
-
-## Notes on upgrading to version 1.0.0
+Coverage reports will be in your `target/scala-<scala-version>/scoverage-report`
+directory.  There are HTML and XML reports. The XML is useful if you need to
+programatically use the results, or if you're writing a tool.
 
-If you are upgrading from 0.99.x then you must remove the `instrumentSettings` from your build.sbt or Build.scala, as that is no longer needed.
+**NOTE**: If you're running the coverage reports from within an sbt console
+session (as opposed to one command per sbt launch), then the `coverage` command
+is sticky.  To turn it back off when you're done running reports, use the
+`coverageOff` command or reset `coverageEnabled` with `set coverageEnabled :=
+false`.
 
-Next, the keys have been renamed slightly. The new names begin with coverageXXX, eg coverageExcludedPackages and some have had their full name changed. You can see a full list of keys by opening the object ScoverageKeys.
+### Multi project reports
 
-## Multi project reports
+By default, scoverage will generate reports for each project separately. You can
+merge them into an aggregated report by using the following:
 
-By default, scoverage will generate reports for each project seperately. You can merge them into an aggregated report by invoking `sbt coverageAggregate`.
-
-(Note, you must do this after all the coverage data is complete as a separate command, so you cannot do `sbt coverage test coverageAggregate` (at least until a way around this is found).)
+```
+$ sbt coverageAggregate
+```
 
-(You must have first run `sbt coverageReport` for `coverageAggregate` to work. It aggregates over the sub-projects' report xml rather than over the coverage data directly.)
+**NOTE**: You do not need to run `coverageReport` before `coverageAggregate`; it
+aggregates over the sub-projects' coverage data directly, not the report xml.
 
-## Exclude classes and packages
+### Exclude classes and packages
 
-You can exclude classes from being considered for coverage measurement by providing semicolon-separated list of
-regular expressions.
+You can exclude classes from being considered for coverage measurement by
+providing semicolon-separated list of regular expressions.
 
-Example:
 ```scala
 coverageExcludedPackages := "<empty>;Reverse.*;.*AuthService.*;models\\.data\\..*"
 ```
 
-The regular expressions are matched against the fully qualified class name, and must match the entire string to take effect.
-
-Any matched classes will not be instrumented or included in the coverage report.
+The regular expressions are matched against the fully qualified class name, and
+must match the entire string to take effect.  Any matched classes will not be
+instrumented or included in the coverage report.
 
 You can also mark sections of code with comments like:
 
@@ -95,67 +81,67 @@ You can also mark sections of code with comments like:
   // $COVERAGE-ON$
 ```
 
-Any code between two such comments will not be instrumented or included in the coverage report.
+Any code between two such comments will not be instrumented or included in the
+coverage report.
 
-## Minimum coverage
+### Minimum coverage
 
-Based on minimum coverage, you can fail the build with the following keys
+Based on minimum coverage, you can fail the build with the following keys:
 
 ```scala
 coverageMinimum := 80
 coverageFailOnMinimum := true
 ```
 
-These settings will be enforced when the reports are generated.
-If you generate an aggregate report using `coverageAggregate` then these settings will apply to that report.
+These settings will be enforced when the reports are generated.  If you generate
+an aggregate report using `coverageAggregate` then these settings will apply to
+that report.
 
-## Highlighting
-
-If you are using Scala 2.11.1 or less, then highlighting will not work (due to this bug which was fixed in 2.11.2 https://github.com/scala/scala/pull/3799). In that case you must disable highlighting by adding the following to your build:
-
-```scala
-coverageHighlighting := false
-```
+## Trouble-shooting failing tests
 
-## Failing tests
-Scoverage does a lot of file writing behind the scenes in order to track which statements have been executed.
-If you are running into a scenario where your tests normally pass, but fail when scoverage is enabled, then the culprit can be one of the following:
+scoverage does a lot of file writing behind the scenes in order to track which
+statements have been executed.  If you are running into a scenario where your
+tests normally pass, but fail when scoverage is enabled, then the culprit can be
+one of the following:
 
 * timing issues on futures and other async operations, try upping the timeouts by an order of magnitude.
 * tests are run in a sandbox mode (such as with `java.security.PrivilegedAction<T>`), try running the tests outside of the sandbox.
 
+## Example project
+
+[the scoverage samples project](https://github.com/scoverage/sbt-scoverage-samples).
+
 ## Integrations
 
 ### Codacy
 
-[Codacy](https://www.codacy.com) integrates with your favorite coverage tool to provide an in-depth overlook of your project status. Scoverage information can be integrated into Codacy through the [sbt-codacy-coverage plugin](https://github.com/codacy/sbt-codacy-coverage).
+[Codacy](https://www.codacy.com) integrates with your favorite coverage tool to
+provide an in-depth overlook of your project status. scoverage information can
+be integrated into Codacy through the
+[codacy-coverage-reporter](https://github.com/codacy/codacy-coverage-reporter).
 
 ### Coveralls
 
-If you have an open source project then you can add code coverage metrics with the excellent website https://coveralls.io/ Scoverage will integrate with coveralls using the [sbt-coveralls](https://github.com/scoverage/sbt-coveralls) plugin.
+If you have an open source project then you can add code coverage metrics with
+the [Coveralls](https://coveralls.io/). scoverage will integrate with coveralls
+using the [sbt-coveralls](https://github.com/scoverage/sbt-coveralls) plugin.
 
-### Plugin for SonarQube
+### Codecov
 
-If you want to visually browse statement coverage reports then use this [plugin for SonarQube](https://github.com/RadoBuransky/sonar-scoverage-plugin).
-It allows you to review overall project statement coverage as well as dig deeper into sub-modules, directories and
-source code files to see uncovered statements. Statement coverage measurement can become an integral part of your
-team's continuous integration process and a required quality standard.
+You can integrate with [Codecov](https://about.codecov.io/) easily sending your
+reports there via your CI. You can see an example of this here in
+[codecov/example-scala](https://github.com/codecov/example-scala).
 
-## License
-```
-This software is licensed under the Apache 2 license, quoted below.
-
-Copyright 2013-2016 Stephen Samuel and contributors
+### Plugin for SonarQube
 
-Licensed under the Apache License, Version 2.0 (the "License"); you may not
-use this file except in compliance with the License. You may obtain a copy of
-the License at
+If you want to visually browse statement coverage reports then use this [plugin
+for SonarQube](https://github.com/RadoBuransky/sonar-scoverage-plugin).  It
+allows you to review overall project statement coverage as well as dig deeper
+into sub-modules, directories and source code files to see uncovered statements.
+Statement coverage measurement can become an integral part of your team's
+continuous integration process and a required quality standard.
 
-    http://www.apache.org/licenses/LICENSE-2.0
+## Release Notes
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-License for the specific language governing permissions and limitations under
-the License.
-```
+For any information on releases and upgrading, please refer to the [release
+page](https://github.com/scoverage/sbt-scoverage/releases).