forked from CS2103JAN2018-F09-B1/main
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation on how to set up and use Coveralls
There is no documentation on how to set up Coveralls. With a detailed explanation, new developers can set up Coveralls easily and receive coverage report after each Travis build. Let's add detailed documentation on how to set up Coveralls along with additional information on customization.
- Loading branch information
1 parent
1bee16f
commit 0ea0ec4
Showing
10 changed files
with
63 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
= Using Coveralls | ||
:imagesDir: images | ||
:stylesDir: stylesheets | ||
|
||
https://coveralls.io/[Coveralls] is a web service that tracks code coverage over time for GitHub projects. | ||
Coveralls requires Travis CI to be set up beforehand as Travis sends the coverage report from the latest build to Coveralls. | ||
If you have not set up Travis CI, see <<UsingTravis#, UsingTravis.adoc>>. Currently, Coveralls supports Travis CI but not AppVeyor. | ||
|
||
== Setting up Coveralls | ||
|
||
. Go to https://coveralls.io/ and click `SIGN IN`. Then click `GITHUB SIGN IN` and enter your GitHub account details if needed. | ||
+ | ||
. After logging in, you will be brought to the `Your Repositories` page. On the site's navigation bar, click https://coveralls.io/repos/new[ADD REPOS]. | ||
+ | ||
. Find the switch for the forked repository. | ||
* If the organization is not shown, click `GITHUB SETTINGS` as shown below: | ||
+ | ||
image:coveralls/github_settings.png[GitHub settings] | ||
+ | ||
This should bring you to a GitHub page that manages the access of third-party applications. Depending on whether you are the owner of the repository, you can either grant access | ||
+ | ||
image:grant_access.png[Grant Access] | ||
+ | ||
or request access | ||
+ | ||
image:request_access.png[Request Access] | ||
+ | ||
to Coveralls so that it can access your repository. | ||
* If your repository cannot be found, click `SYNC REPOS`. | ||
+ | ||
image:coveralls/sync_repos.png[Sync repos] | ||
+ | ||
. Activate the switch. | ||
+ | ||
image:coveralls/flick_repository_switch.png[Activate the switch] | ||
+ | ||
. Update the link of the `Coverage Status` badge at the top of your <<README#, README.adoc>> to point to that of your own repo by replacing the outlined areas with `your-org-name/your-repo-name`. | ||
+ | ||
image:coveralls/coverage_asciidoc_code.png[Coverage Status Badge] | ||
+ | ||
. You can now see the coverage report for your project after each Travis build by clicking on the `Coverage Status` badge. | ||
+ | ||
image:coveralls/coverage_report.png[Coverage Report Summary] | ||
|
||
== Disabling Coveralls Automatic Comments on Pull Requests | ||
|
||
Coveralls automatically comments on the coverage status of the pull requests in GitHub. If it's a hindrance, you can disable it in the settings of your project in Coveralls: | ||
|
||
. Click `Settings`. | ||
+ | ||
. Uncheck the `LEAVE COMMENTS?` checkbox. Then click `SAVE CHANGES`. | ||
+ | ||
image:coveralls/disable_comments.png[Disable comments, width = 942] |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.