jandedobbeleer / coveralls

coveralls

A PowerShell module to publish code coverage to Coveralls.io using Pester

Usage

Decide which files you want to have covered (similar to the way Pester handles it).

$files = @('Helpers\PoshGit.ps1','Helpers\Prompt.ps1','install.ps1')

You could also use Get-ChildItem with wildcards instead.

$files = Get-ChildItem * -Include *.ps1,*.psm1

Get the infomation and publish it to Coveralls.io

$token = 'BHJjjgRTHGgs776BGTYcdcjJT987jjGG'
$coverage = Format-Coverage -Include $files -CoverallsApiToken $token
Publish-Coverage -Coverage $coverage

If you run you tests outside of the root folder of your repository, you need to specify it's location so that Coveralls can find the files and display the information nicely.

$coverage = Format-Coverage -Include $files -CoverallsApiToken $token -RootFolder ../

In case your CI does not allow you to fetch the branchname due to a checkout on a commit, you can specify it otherwise. This example uses Appveyor's environment variables.

$coverage = Format-Coverage -Include $files -CoverallsApiToken $token -BranchName $ENV:APPVEYOR_REPO_BRANCH

It's also possible to include a Pester result not to have to run Pester twice. Just provide the result and your good to go (make sure it has the code coverage included).

$coverage = Format-Coverage -PesterResults $result -CoverallsApiToken $token

coveralls's Issues

Issues installing Coveralls on PS Core on Linux

Hi,

Coveralls fails to install when running PS Core on Linux. This is because the module name on PS gallery is "coveralls" (with a lowercase c) but the module file is "Coveralls.pd1" with an uppercase C. Although Install-Module works, Import-Module fails to run as it expects the module directory name to match the module file name (which on a case sensitive filesystem, doesn't).

At the moment I'm having to do the following workaround in my build scripts:

Install-Module Coveralls -MinimumVersion 1.0.25 -MaximumVersion 1.0.25 -Scope CurrentUser -Force
# Import-Module without an explicit path fails
Import-Module (Resolve-Path "~/.local/share/powershell/Modules/coveralls/1.0.25/Coveralls.psd1")

Please could the module files be renamed to be all lowercase? This shouldn't be a breaking change for Windows.

Thanks!

WARNING: The -Quiet parameter has been deprecated; please use the new -Show parameter instead. To get no output use -Show None.

When executing:
`$coverage = Format-Coverage -Include $files -CoverallsApiToken $token -BranchName master

No updates or output

Hey!

I tried hooking up my build using coveralls but I am not getting any useful output. Same when I run the commands manually.

Latest build (let me know if you can see it) - https://ci.appveyor.com/project/JustinSider/powerrestcli
Repo - https://github.com/jpsider/PowerRestCLI

I'm missing something, just not sure what.

Thanks!

-Justin