Skip to content

New-ConfigurationProjectBuild.md

Latest commit

 

History

History
300 lines (239 loc) · 6.65 KB

New-ConfigurationProjectBuild.md

File metadata and controls

300 lines (239 loc) · 6.65 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

New-ConfigurationProjectBuild

SYNOPSIS

References an existing project.build.json package build from the module-build DSL.

SYNTAX

__AllParameterSets

New-ConfigurationProjectBuild [-Name <string>] [-ConfigPath <string>] [-Enabled] [-BuildBeforeModule] [-UseAsReleaseVersionSource] [-ProvideLocalNuGetFeed] [-UpdateVersions] [-Build] [-IncludeSymbols] [-PublishNuget] [-PublishGitHub] [-CreateReleaseZip] [-SignAssemblies] [-SignDependencyAssemblies] [-SignPackages] [-Options <IDictionary>] [<CommonParameters>]

DESCRIPTION

Use this cmdlet inside Build-Module { } when package build details already live in a JSON file and the module build should coordinate with that package lane.

EXAMPLES

EXAMPLE 1

New-ConfigurationProjectBuild -ConfigPath 'C:\Path'

PARAMETERS

-Build

Whether package projects should be built/packed, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-BuildBeforeModule

Whether package outputs must be produced before the module lane runs.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-ConfigPath

Path to an existing project.build.json file.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-CreateReleaseZip

Whether release ZIPs should be created, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Enabled

Whether this project build lane is enabled. Defaults to true.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-IncludeSymbols

Whether portable symbol packages should be created, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Name

Optional friendly name for this package build lane.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Options

Additional project-build JSON overrides for less common fields.

Type: IDictionary
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-ProvideLocalNuGetFeed

Whether package outputs should be exposed as a temporary local NuGet feed for the module lane.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-PublishGitHub

Whether package GitHub release publishing should be enabled, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-PublishNuget

Whether NuGet packages should be published, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-SignAssemblies

Whether assemblies should be signed before packages are created, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-SignDependencyAssemblies

Whether copied dependency assemblies should also be signed, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-SignPackages

Whether generated NuGet packages should be signed, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-UpdateVersions

Whether project/package versions should be updated, overriding the referenced JSON when set.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-UseAsReleaseVersionSource

Whether the resolved package version should be used as the unified release version source.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

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

  • None

OUTPUTS

  • PowerForge.ConfigurationProjectBuildSegment

RELATED LINKS

  • None