Document coverage settings

Author: stringbean

src/main/scala/com/github/sbt/jacoco/coveralls/CoverallsClient.scala

@@ -22,6 +22,7 @@ object CoverallsClient {
   private val jobsUrl = "https://coveralls.io/api/v1/jobs"
 
   def sendReport(reportFile: File, streams: TaskStreams): Unit = {
+    streams.log.info("Uploading coverage to coveralls.io...")
     val response = Http(jobsUrl)
       .postMulti(
         MultiPart(

src/main/scala/com/github/sbt/jacoco/coveralls/JacocoCoverallsPlugin.scala

@@ -33,16 +33,14 @@ object JacocoCoverallsPlugin extends BaseJacocoPlugin {
     val jacocoCoverallsBuildNumber: SettingKey[Option[String]] = settingKey("Build number to send to Coveralls")
     val jacocoCoverallsJobId: SettingKey[String] = settingKey("Build job ID to send to Coveralls")
     val jacocoCoverallsPullRequest: SettingKey[Option[String]] = settingKey("Pull request number to send to Coveralls")
-    val jacocoCoverallsOutput: SettingKey[File] = settingKey("File to store Coveralls coverage")
     val jacocoCoverallsRepoToken: SettingKey[Option[String]] = settingKey("Coveralls repo secret key")
   }
 
   import autoImport._ // scalastyle:ignore import.grouping
 
   override def projectSettings: Seq[Setting[_]] = Seq(
-    jacocoCoverallsOutput := jacocoReportDirectory.value,
     jacocoCoveralls := Def.task {
-      CoverallsClient.sendReport(jacocoCoverallsOutput.value / "coveralls.json", streams.value)
+      CoverallsClient.sendReport(jacocoReportDirectory.value / "coveralls.json", streams.value)
     }.value,
     jacocoCoverallsGenerateReport := Def.taskDyn {
       if (jacocoCoverallsJobId.value.isEmpty) {
@@ -61,7 +59,7 @@ object JacocoCoverallsPlugin extends BaseJacocoPlugin {
             )
 
           ReportUtils.generateReport(
-            jacocoCoverallsOutput.value,
+            jacocoReportDirectory.value,
             jacocoDataFile.value,
             jacocoReportSettings.value.withFormats(coverallsFormat),
             coveredSources.value,

src/paradox/coverage-services.md

@@ -5,7 +5,7 @@ example project: [stringbean/sbt-jacoco-example](https://github.com/stringbean/s
 
 ## Coveralls
 
-Enable the Coveralls plugin:
+If you have a public project built with Travis-CI you will just need to enable the Coveralls plugin:
 
 ```scala
 enablePlugins(JacocoCoverallsPlugin)
@@ -14,10 +14,19 @@ enablePlugins(JacocoCoverallsPlugin)
 Then run `sbt jacocoCoveralls` to upload the results to Coveralls:
 
 ```
+[info] Uploading coverage to coveralls.io...
 [info] Upload complete
 ```
 
-<!-- TODO extra config -->
+For private projects you will need to set a few more settings:
+
+```scala
+jacocoCoverallsServiceName := "jenkins"
+jacocoCoverallsJobId := sys.env("BUILD_ID")
+jacocoCoverallsRepoToken := "<repo token on coveralls.io>"
+```
+
+More settings can found at @ref:[Coveralls Plugin](settings.md#coveralls) settings.
 
 ## Codecov
 
@@ -32,8 +41,9 @@ jacocoReportSettings := JacocoReportSettings(
   "utf-8")
 ```
 
-With this enabled run the Codecov script:
+With this enabled run the Codecov script after JaCoCo:
 
 ```shell
+sbt jacoco
 bash <(curl -s https://codecov.io/bash)
 ```

src/paradox/index.md

@@ -8,6 +8,7 @@ Key features of _sbt-jacoco_ include:
 * Coverage of Scala and Java code.
 * Aggregation of multi-project builds.
 * Support for unit and @ref:[integration](integration-tests.md) tests.
+* @ref:[Integrates](coverage-services.md) with Coveralls and Codecov.
 
 @@@ index
 

src/paradox/settings.md

@@ -138,6 +138,44 @@ JacocoReportSettings(
 * **Accepts:** `Boolean`
 * **Default:** `true`
 
+### Coveralls
+
+These are only defined if the `JacocoCoverallsPlugin` is enabled.
+
+#### jacocoCoverallsServiceName
+
+* **Description:** Name of the CI service running this build.
+* **Accepts:** `String`
+* **Default:** `travis-ci`
+
+@@@ note
+If running on Travis Pro this should be set to `travis-pro`.
+@@@
+
+#### jacocoCoverallsJobId
+
+* **Description:** Unique build identifier for this build
+* **Accepts:** `String`
+* **Default:** `TRAVIS_JOB_ID` environment variable
+
+#### jacocoCoverallsBuildNumber
+
+* **Description:** Human readable build number
+* **Accepts:** `Option[String]`
+* **Default:** none (defaults to auto-incremented number)
+
+#### jacocoCoverallsPullRequest
+
+* **Description:** ID of the current pull request that triggered the build.
+* **Accepts:** `Option[String]`
+* **Default:** none
+
+#### jacocoCoverallsRepoToken
+
+* **Description:** Coveralls repo secret key.
+* **Accepts:** `Option[String]`
+* **Default:** none (auto detected for public repos)
+
 ## Types
 
 All types are automatically imported in an `.sbt` based build file and can be imported into `.scala` based builds using: