New-ConfigurationDelivery.md

external help file	PSPublishModule-help.xml
Module Name	PSPublishModule
online version	https://github.com/EvotecIT/PSPublishModule
schema	2.0.0

New-ConfigurationDelivery

SYNOPSIS

Configures delivery metadata for bundling and installing internal docs/examples.

SYNTAX

__AllParameterSets

New-ConfigurationDelivery [-Enable] [-InternalsPath <string>] [-Sign] [-IncludeRootReadme] [-IncludeRootChangelog] [-IncludeRootLicense] [-ReadmeDestination <DeliveryBundleDestination>] [-ChangelogDestination <DeliveryBundleDestination>] [-LicenseDestination <DeliveryBundleDestination>] [-ImportantLinks <DeliveryImportantLink[]>] [-IntroText <string[]>] [-UpgradeText <string[]>] [-IntroFile <string>] [-UpgradeFile <string>] [-RepositoryPaths <string[]>] [-RepositoryBranch <string>] [-DocumentationOrder <string[]>] [-IncludePaths <string[]>] [-ExcludePaths <string[]>] [-PreservePaths <string[]>] [-OverwritePaths <string[]>] [-GenerateInstallCommand] [-GenerateUpdateCommand] [-InstallCommandName <string>] [-UpdateCommandName <string>] [<CommonParameters>]

DESCRIPTION

Delivery configuration is used to bundle “internals” (docs, examples, tools, configuration files) into a module and optionally generate public helper commands (Install- / Update-) that can copy these files to a target folder.

This is intended for “script packages” where the module contains additional artifacts that should be deployed alongside it.

Generated install helpers default to merge behavior. Generated update helpers default to refresh behavior, which overwrites package files while keeping local files that are not part of the package. Use IncludePaths and ExcludePaths to scope which package files are managed, then use PreservePaths and OverwritePaths to fine-tune collision behavior for managed relative paths.

EXAMPLES

EXAMPLE 1

PS> New-ConfigurationDelivery -Enable -InternalsPath 'Internals' -IncludeRootReadme -IncludeRootChangelog -GenerateInstallCommand -GenerateUpdateCommand -Sign

Generates public Install/Update helpers, bundles README/CHANGELOG into the module, and requests signing for bundled internals during build.

EXAMPLE 2

PS> New-ConfigurationDelivery -Enable -RepositoryPaths 'docs' -RepositoryBranch 'main' -DocumentationOrder '01-Intro.md','02-HowTo.md'

Helps modules expose docs from a repository path in a consistent order.

EXAMPLE 3

PS> New-ConfigurationDelivery -Enable -GenerateInstallCommand -GenerateUpdateCommand -InstallCommandName 'Install-ContosoToolkit' -UpdateCommandName 'Update-ContosoToolkit' -IncludePaths 'Config/**','Scripts/*.ps1' -ExcludePaths 'Config/local/**' -PreservePaths 'Config/config.json' -OverwritePaths 'Bin/**','Templates/**'

Generates custom delivery helpers, manages only selected package files, excludes local-only configuration paths, preserves the active configuration during refresh updates, and can refresh selected paths during merge installs.

PARAMETERS

-ChangelogDestination

Where to bundle CHANGELOG.* within the built module.

Type: DeliveryBundleDestination
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Internals, Root, Both, None

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

-DocumentationOrder

Optional file-name order for Internals\Docs when rendering documentation.

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

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

-Enable

Enables delivery metadata emission.

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

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

-ExcludePaths

Optional wildcard patterns (relative to InternalsPath) that generated Install-/Update- helpers should not copy, refresh, or consider package-owned. Exclusions win over IncludePaths. Use this for local-only or user-owned package-adjacent paths such as Config/local/** or Config/config.json.

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

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

-GenerateInstallCommand

When set, generates a public Install- helper function during build that copies Internals to a destination folder.

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

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

-GenerateUpdateCommand

When set, generates a public Update- helper function during build that delegates to the install command in refresh mode by default.

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

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

-ImportantLinks

Important links (Title/Url). Accepts legacy hashtable array (@{ Title='..'; Url='..' }) or DeliveryImportantLink[].

Type: DeliveryImportantLink[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-IncludePaths

Optional wildcard patterns (relative to InternalsPath) that define which package files generated Install-/Update- helpers manage. Use this when a module ships mixed content but only selected folders should be copied or refreshed, for example Config/.sample.json and Scripts/.ps1. When omitted, all files under InternalsPath are managed.

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

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

-IncludeRootChangelog

Include module root CHANGELOG.* during installation.

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

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

-IncludeRootLicense

Include module root LICENSE.* during installation.

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

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

-IncludeRootReadme

Include module root README.* during installation.

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

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

-InstallCommandName

Optional override name for the generated install command. When empty, defaults to Install-.

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

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

-InternalsPath

Relative path inside the module that contains internal deliverables.

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

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

-IntroFile

Relative path (within the module root) to a Markdown/text file to use as Intro content.

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

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

-IntroText

Text lines shown to users after Install-ModuleDocumentation completes.

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

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

-LicenseDestination

Where to bundle LICENSE.* within the built module.

Type: DeliveryBundleDestination
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Internals, Root, Both, None

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

-OverwritePaths

Optional wildcard patterns (relative to Internals) that should be overwritten during merge installs by generated Install-/Update- helpers. Example: Artefacts/**.

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

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

-PreservePaths

Optional wildcard patterns (relative to Internals) that should be preserved during merge or refresh installs by generated Install-/Update- helpers. Example: Config/**.

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

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

-ReadmeDestination

Where to bundle README.* within the built module.

Type: DeliveryBundleDestination
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Internals, Root, Both, None

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

-RepositoryBranch

Optional branch name to use when fetching remote documentation.

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

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

-RepositoryPaths

One or more repository-relative paths from which to display remote documentation files.

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

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

-Sign

When set, requests signing for files under InternalsPath using the configured module signing settings/certificate.

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

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

-UpdateCommandName

Optional override name for the generated update command. When empty, defaults to Update-.

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

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

-UpgradeFile

Relative path (within the module root) to a Markdown/text file to use for Upgrade instructions.

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

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

-UpgradeText

Text lines with upgrade instructions shown when requested.

Type: String[]
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

• System.Object

RELATED LINKS

• None