Set-PSProjectFile
SYNOPSIS
Creates and modify needed files for a PS project from existing module files.
SYNTAX
Set-PSProjectFile [-ModuleScriptFile] <FileInfo> [[-VersionBump] <String>] [[-ReleaseNotes] <String>]
[-BuildHelpFiles] [-DeployMKDocs] [-RunScriptAnalyzer] [-GitPush] [-CopyToModulesFolder] [-CopyNestedModules]
[-ShowReport] [<CommonParameters>]
DESCRIPTION
Creates and modify needed files for a PS project from existing module files.
EXAMPLES
EXAMPLE 1
Set-PSProjectFiles -ModuleScriptFile blah.psm1 -VersionBump Minor -mkdocs serve
PARAMETERS
-ModuleScriptFile
Path to module .psm1 file.
Type: FileInfo
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VersionBump
This will increase the version of the module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: Revision
Accept pipeline input: False
Accept wildcard characters: False
-ReleaseNotes
Add release notes to the manifest file.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Updated Module Online Help Files
Accept pipeline input: False
Accept wildcard characters: False
-BuildHelpFiles
Use Platyps to build markdown help files.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DeployMKDocs
Create or test the mkdocs site
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-RunScriptAnalyzer
Run RunScriptAnalyzer functions.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-GitPush
Run Git Push when done.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-CopyToModulesFolder
Copies the module to program files.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-CopyNestedModules
Will copy the required modules to the nested modules folder.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ShowReport
Will open the issues report in a browser.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.