Skip to content

New SamplerPipeline

gaelcolas edited this page Jul 18, 2024 · 1 revision

New-SamplerPipeline

SYNOPSIS

Create a Sampler scaffolding so you can add samples & build pipeline.

SYNTAX

New-SamplerPipeline [-DestinationPath] <String> [-Pipeline] <String> 
 [<CommonParameters>]

DESCRIPTION

New-SamplerPipeline helps you bootstrap your project pipeline, whether it's for a Chocolatey package, Azure Policy Guest Configuration packages or just a pipeline for a CI process.

EXAMPLES

EXAMPLE 1

New-SamplerPipeline -DestinationPath . -Pipeline Build -ProjectName MyBuild -License 'true' -LicenseType MIT -SourceDirectory Source  -MainGitBranch main -ModuleDescription 'some desc' -CustomRepo PSGallery -Features All

PARAMETERS

-DestinationPath

Destination of your project's root folder, defaults to the current directory ".". We assume that your current location is the module folder, and within this folder we will find the source folder, the tests folder and other supporting files such as build.ps1, the entry point.

Type: String
Parameter Sets: (All)
Aliases: Path

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

-Pipeline

Type of Pipeline you would like to create at the destination folder. You can create a base pipeline using th value Build that will include the bootstrap and resolve dependency process, but you will need to edit the Build.Yaml to call the tasks you desire. You can also create a Chocolatey pipeline, preconfigured to build Chocolatey packages, or call a Sampler pipeline.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
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

System.Void

NOTES

Other parameters will be displayed based on the Template used for the pipeline. See Add-Sample to add elements such as functions (private or public), tests, DSC Resources to your project.

RELATED LINKS

Clone this wiki locally