Skip to content

Set-BuildEnvironment.md

Latest commit

 

History

History
545 lines (432 loc) · 9.66 KB

Set-BuildEnvironment.md

File metadata and controls

545 lines (432 loc) · 9.66 KB
Raw

external help file: ModuleBuild-help.xml online version: https://github.com/zloeber/ModuleBuild schema: 2.0.0

Set-BuildEnvironment

SYNOPSIS

Sets a stored setting in a buildenvironment.json file.

SYNTAX

Set-BuildEnvironment [[-Path] <String>] [-AdditionalModulePaths <Object[]>] [-BaseReleaseFolder <String>]
 [-BaseSourceFolder <String>] [-BuildToolFolder <String>] [-Encoding <String>] [-FirstRun <Boolean>]
 [-Force <Boolean>] [-ForceInstallModule <Boolean>] [-FunctionTemplates <String>] [-ModuleAuthor <String>]
 [-ModuleCopyright <String>] [-ModuleDescription <String>] [-ModuleLicenseURI <String>]
 [-ModuleTags <Object[]>] [-ModuleToBuild <String>] [-ModuleVersion <String>] [-ModuleWebsite <String>]
 [-NugetAPIKey <String>] [-OptionAnalyzeCode <Boolean>] [-OptionCombineFiles <Boolean>]
 [-OptionGenerateReadTheDocs <Boolean>] [-OptionRunPlatyPSVerbose <Boolean>]
 [-OptionSanitizeSensitiveTerms <Boolean>] [-OptionSensitiveTerms <Object[]>]
 [-OptionSensitiveTermsInitialized <Boolean>] [-OptionTranscriptEnabled <Boolean>]
 [-OptionTranscriptLogFile <String>] [-OptionUpdateVersionAfterPublishing <Boolean>]
 [-OtherModuleSource <String>] [-PrivateFunctionSource <String>] [-PublicFunctionSource <String>]
 [-ScratchFolder <String>]

DESCRIPTION

Sets the stored setting in a buildenvironment.json file.

EXAMPLES

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

Set-BuildEnvironment -OptionSensitiveTerms @('myapikey','myname','password')

PARAMETERS

-Path

Specifies the path to a buildenvironment.json file.

Type: String
Parameter Sets: (All)
Aliases: 

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

-AdditionalModulePaths

Update the setting for AdditionalModulePaths

Type: Object[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-BaseReleaseFolder

Update the setting for BaseReleaseFolder

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-BaseSourceFolder

Update the setting for BaseSourceFolder

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-BuildToolFolder

Update the setting for BuildToolFolder

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Encoding

Update the setting for Encoding

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-FirstRun

Update the setting for FirstRun

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

Update the setting for Force

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ForceInstallModule

Update the setting for ForceInstallModule

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-FunctionTemplates

Update the setting for FunctionTemplates

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ModuleAuthor

Update the setting for ModuleAuthor

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ModuleCopyright

Update the setting for ModuleCopyright

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ModuleDescription

Update the setting for ModuleDescription

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ModuleLicenseURI

Update the setting for ModuleLicenseURI

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ModuleTags

Update the setting for ModuleTags

Type: Object[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ModuleToBuild

Update the setting for ModuleToBuild

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ModuleVersion

Update the setting for ModuleVersion

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ModuleWebsite

Update the setting for ModuleWebsite

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NugetAPIKey

Update the setting for NugetAPIKey

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionAnalyzeCode

Update the setting for OptionAnalyzeCode

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionCombineFiles

Update the setting for OptionCombineFiles

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionGenerateReadTheDocs

Update the setting for OptionGenerateReadTheDocs

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionRunPlatyPSVerbose

Update the setting for OptionRunPlatyPSVerbose

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionSanitizeSensitiveTerms

Update the setting for OptionSanitizeSensitiveTerms

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionSensitiveTerms

Update the setting for OptionSensitiveTerms

Type: Object[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionSensitiveTermsInitialized

Update the setting for OptionSensitiveTermsInitialized

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionTranscriptEnabled

Update the setting for OptionTranscriptEnabled

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionTranscriptLogFile

Update the setting for OptionTranscriptLogFile

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OptionUpdateVersionAfterPublishing

Update the setting for OptionUpdateVersionAfterPublishing

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OtherModuleSource

Update the setting for OtherModuleSource

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PrivateFunctionSource

Update the setting for PrivateFunctionSource

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PublicFunctionSource

Update the setting for PublicFunctionSource

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ScratchFolder

Update the setting for ScratchFolder

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/zloeber/ModuleBuild