< Back

New-CoverallsReport

Sun Jan 19, 2020 6:35 pm

NAME New-CoverallsReport



SYNOPSIS

Creates a Coveralls.io report from the Code Coverage report from Pester.





SYNTAX

New-CoverallsReport [-Coverage] <Object> [-ServiceName] <String> [[-BranchName] <String>] [[-RootFolder] <String>]

[<CommonParameters>]





DESCRIPTION

Creates a Coveralls.io report from the Code Coverage report from Pester.





PARAMETERS

-Coverage <Object>

The Pester test report that contains the CodeCoverage



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ServiceName <String>

The Name of which CI Service the report is being generated

Examples are: appveyor, travis-ci, github-actions, jenkins, etc



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-BranchName <String>

The Name of the branch for which the report is being generated



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RootFolder <String>

Optional root folder path



Required? false

Position? 4

Default value $pwd

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

System.Collections.Hashtable





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$report = New-CoverallsReport -Coverage $PesterReport.CodeCoverage -ServiceName 'github-actions'

-BranchName master















RELATED LINKS