coveralls.net

Coveralls uploader for .Net code coverage reporting

Getting started

Coveralls is a service which keep track of code coverate statistics. The process is as follows

• You push your code to GitHub.
• Your build server AppVeyor builds, runs unit tests, and using coveralls.net sends coverage information to the coverage service.
• In turn, your coveralls badge gets updated.

Getting started is easy, just do the following

0. Using nuget, add the following dependencies to your project nunit-runner, coveralls.net, opencover.
1. Separate your test files into a separate ...Tests project.
2. We assume you already have a set up with AppVeyor. If not get started on that.
3. Register at https://coveralls.io/ and point to your github project
4. Coveralls will the tell you your secret token like repo_token: PlKcHlYUjBpsvFEzSnScYzMDseJi9ASNx
5. Do not publish this token, instead encrypt it using https://ci.appveyor.com/tools/encrypt
6. Add a appveyor.yml to the root of your project. The minimum configuration probably is:

version: 1.0.{build}

install:
    - nuget restore
    
build:
  project: YOURPROJECT.sln
  verbosity: detailed

environment:
    COVERALLS_REPO_TOKEN:  
       secure: ybaVTwokoDe5aIFj3RF2Aea5999hmNS7zaLNnSSy0tJkaC+3SJ3MpBbeTVZqF3q+
 
after_test: 
    - packages\OpenCover.4.5.3522\OpenCover.Console.exe -register:user -filter:"+[*]*" -target:"packages\NUnit.Runners.2.6.4\tools\nunit-console.exe" -targetargs:"/noshadow /domain:single  YOURPROJECT.Tests\bin\debug\YOURPROJECT.Tests.dll" -output:coverage.xml
        
    - packages\coveralls.io.1.1.86\tools\coveralls.net.exe --opencover coverage.xml

For a more elaborate example look at https://github.com/jdeering/coveralls.net/blob/master/appveyor.yml

Supported Frameworks

• OpenCover

Planned

These are the remaining targets, but I'm not sure how far I will be able to get on my own. If you would like to help, please fork this repository

• SharpCover
• Mono Code Coverage (monocov)
• Visual Studio Coverage
• NCover

Versioning

coveralls.net will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:

<major>.<minor>.<build>

and constructed with the following guidelines:

• Breaking backward compatibility bumps the major (resetting the minor and build)
• New additions without breaking backward compatibility bumps the minor (resetting the build)
• Bug fixes and misc changes increase the build number

For more information on SemVer, please visit http://semver.org/.

Bug tracker

Have a bug or a feature request? Please open a new issue. Before opening a new issue, please search for existing issues.

Contributing

Please submit all pull requests against WIP branches. You must include all relevant unit tests for any bug fixes or new features.

Thanks!

Authors

Jason Deering

• http://twitter.com/jasondeering
• http://github.com/jdeering

License

Licensed under the GNU General Public License, Version 3.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at:

• http://www.gnu.org/licenses/gpl-3.0.txt

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.