Get PesterOutputFileFileName

Get-PesterOutputFileFileName

SYNOPSIS

Gets a descriptive file name to be used as Pester Output file name.

SYNTAX

Get-PesterOutputFileFileName [-ProjectName] <String> [-ModuleVersion] <String> [-OsShortName] <String>
 [-PowerShellVersion] <String> [<CommonParameters>]

DESCRIPTION

Creates a file name to be used as Pester Output xml file composed like so: "${ProjectName}_v${ModuleVersion}.${OsShortName}.${PowerShellVersion}.xml"

EXAMPLES

EXAMPLE 1

Get-PesterOutputFileFileName -ProjectName 'Sampler' -ModuleVersion 0.110.4-preview001 -OsShortName Windows -PowerShellVersion 5.1

PARAMETERS

-ModuleVersion

Module Version currently defined (including pre-release but without the metadata).

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OsShortName

Platform name either Windows, Linux, or MacOS.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PowerShellVersion

Version of PowerShell the tests have been running on.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProjectName

Name of the Project or module being built.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

General notes

RELATED LINKS