Support COVERALLS_PARALLEL environment variable (#250)

Per documentation at https://docs.coveralls.io/parallel-build-webhook fixes #245
JuliaCI · Nov 25, 2019 · bd7fe77 · bd7fe77
1 parent 9e3c9e2
commit bd7fe77
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 3 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -12,10 +12,12 @@ julia:
   - nightly
 
 notifications:
-    email: false
+  webhooks: https://coveralls.io/webhook
+  email: false
 
 script:
   - julia --check-bounds=yes etc/travis-test.jl
+  - export COVERALLS_PARALLEL=true
   # submit coverage data, and collect new coverage data on that
   - julia --code-coverage=user etc/travis-coverage.jl
   # submit coverage data *again*, this time without code coverage

diff --git a/README.md b/README.md
@@ -173,6 +173,17 @@ When using Coverage.jl locally, over time a lot of `.cov` files can accumulate.
        - C:\projects\julia\bin\julia -e "using Pkg; Pkg.add(\"Coverage\"); using Coverage; Coveralls.submit(process_folder())"
        ```
 
+4. If you are uploading from multiple jobs, you'll need to tell Coveralls to merge the results after all CI jobs have completed. See https://docs.coveralls.io/parallel-build-webhook for general instructions.
+
+    For Travis, this can be achieved by adding the following to `.travis.yml`:
+
+        env:
+          global:
+            - COVERALLS_PARALLEL=true
+        notifications:
+          webhooks: https://coveralls.io/webhook
+
+
 ## A note for advanced users
 
 Coverage tracking in Julia is not yet quite perfect. One problem is that (at

diff --git a/src/coveralls.jl b/src/coveralls.jl
@@ -99,6 +99,9 @@ module Coveralls
         end
 
         data = add_repo_token(data, local_env)
+        if get(ENV, "COVERALLS_PARALLEL", "false") == "true"
+            data["parallel"] = "true"
+        end
         return data
     end
 
@@ -185,6 +188,7 @@ module Coveralls
         verbose && @info "Submitting data to Coveralls..."
         req = HTTP.post("https://coveralls.io/api/v1/jobs", HTTP.Form(makebody(data)))
         verbose && @debug "Result of submission:\n" * String(req.body)
+        nothing
     end
 
     # adds the repo token to the data

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -600,29 +600,34 @@ withenv(
                 @test request["service_job_id"] == "my_job_id"
                 @test request["service_name"] == "appveyor"
                 @test request["service_pull_request"] == "t_pr"
+                @test !haskey(request, "parallel")
         end
 
         # test Travis
         withenv("TRAVIS" => "true",
                 "TRAVIS_JOB_ID" => "my_job_id",
-                "TRAVIS_PULL_REQUEST" => "t_pr") do
+                "TRAVIS_PULL_REQUEST" => "t_pr",
+                "COVERALLS_PARALLEL" => "true") do
                 request = Coverage.Coveralls.prepare_request(fcs, false)
                 @test request["repo_token"] == "token_name_1"
                 @test request["service_job_id"] == "my_job_id"
                 @test request["service_name"] == "travis-ci"
                 @test request["service_pull_request"] == "t_pr"
+                @test request["parallel"] == "true"
         end
 
         # test Jenkins
         withenv("JENKINS" => "true",
                 "BUILD_ID" => "my_job_id",
-                "CI_PULL_REQUEST" => true) do
+                "CI_PULL_REQUEST" => true,
+                "COVERALLS_PARALLEL" => "not") do
                 my_git_info = Dict("remote_name" => "my_origin")
                 request = Coverage.Coveralls.prepare_request(fcs, false)
                 @test request["repo_token"] == "token_name_1"
                 @test request["service_job_id"] == "my_job_id"
                 @test request["service_name"] == "jenkins-ci"
                 @test !haskey(request, "service_pull_request")
+                @test !haskey(request, "parallel")
 
                 withenv("CI_PULL_REQUEST" => "false",
                         "GIT_BRANCH" => "my_remote/my_branch") do