Skip to content

Commit 3fcc239

Browse files
authored
Merge pull request #7421 from IQSS/7321-coveralls
7321 coveralls
2 parents 9cce13d + 93bc3ef commit 3fcc239

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

doc/sphinx-guides/source/developers/testing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ We use a variety of tools to write, execute, and measure the code coverage of un
4141

4242
As you prepare to make a pull request, as described in the :doc:`version-control` section, you will be working on a new branch you create from the "develop" branch. Let's say your branch is called ``1012-private-url``. As you work, you are constantly invoking Maven to build the war file. When you do a "clean and build" in Netbeans, Maven runs all the unit tests (anything ending with ``Test.java``) and the runs the results through a tool called Jacoco that calculates code coverage. When you push your branch to GitHub and make a pull request, a web service called Travis CI runs Maven and Jacoco on your branch and pushes the results to Coveralls, which is a web service that tracks changes to code coverage over time.
4343

44-
To make this more concrete, observe that https://github.com/IQSS/dataverse/pull/3111 has comments from a GitHub user called ``coveralls`` saying things like "Coverage increased (+0.5%) to 5.547% when pulling dd6ceb1 on 1012-private-url into be5b26e on develop." Clicking on the comment should lead you to a URL such as https://coveralls.io/builds/7013870 which shows how code coverage has gone up or down. That page links to a page such as https://travis-ci.org/IQSS/dataverse/builds/144840165 which shows the build on the Travis side that pushed the results ton Coveralls.
44+
To make this more concrete, observe that https://github.com/IQSS/dataverse/pull/3111 has comments from a GitHub user called ``coveralls`` saying things like "Coverage increased (+0.5%) to 5.547% when pulling dd6ceb1 on 1012-private-url into be5b26e on develop." Clicking on the comment should lead you to a URL such as https://coveralls.io/builds/7013870 which shows how code coverage has gone up or down. That page links to a page such as https://travis-ci.org/IQSS/dataverse/builds/144840165 which shows the build on the Travis side that pushed the results to Coveralls. Note that we have configured Coveralls to not mark small decreases in code coverage as a failure.
4545

4646
The main takeaway should be that we care about unit testing enough to measure the changes to code coverage over time using automation. Now let's talk about how you can help keep our code coverage up by writing unit tests with JUnit.
4747

doc/sphinx-guides/source/installation/prerequisites.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ components and libraries. Please consult the instructions in the
322322
Installing R
323323
============
324324

325-
For RHEL/CentOS, the EPEL distribution is strongly recommended::
325+
For RHEL/CentOS, the EPEL distribution is strongly recommended:
326326

327327
If :fixedwidthplain:`yum` isn't configured to use EPEL repositories ( https://fedoraproject.org/wiki/EPEL ):
328328

0 commit comments

Comments
 (0)