Publish-ManagedModule.md

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

Publish-ManagedModule

SYNOPSIS

Publishes a PowerShell module package through the managed C# module engine.

SYNTAX

PathParameterSet (Default)

Publish-ManagedModule [-Path] <string> [[-Repository] <string>] [-RepositoryName <string>] [-ProfileName <string>] [-OutputDirectory <string>] [-ManifestPath <string>] [-Name <string>] [-Version <string>] [-Authors <string>] [-Description <string>] [-ProjectUrl <string>] [-Tags <string[]>] [-Credential <pscredential>] [-ApiKey <string>] [-ApiKeyFilePath <string>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-Force] [-SkipDependenciesCheck] [-SkipModuleManifestValidate] [-ShowSummary] [-WhatIf] [-Confirm] [<CommonParameters>]

NupkgPathParameterSet

Publish-ManagedModule [[-Repository] <string>] -NupkgPath <string> [-RepositoryName <string>] [-ProfileName <string>] [-OutputDirectory <string>] [-Credential <pscredential>] [-ApiKey <string>] [-ApiKeyFilePath <string>] [-Proxy <uri>] [-ProxyCredential <pscredential>] [-Force] [-SkipDependenciesCheck] [-ShowSummary] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This command provides the module-publish functionality of Publish-PSResource. It can create a NuGet package from a module folder or publish an existing .nupkg file to a local folder feed or NuGet-compatible package publish endpoint.

Microsoft Artifact Registry module prefixes are not applied because the managed repository client does not yet expose a container-registry transport.

EXAMPLES

EXAMPLE 1

Publish-ManagedModule -Path C:\Source\Company.Tools -Repository C:\Packages

EXAMPLE 2

Publish-ManagedModule -NupkgPath C:\Packages\Company.Tools.1.2.0.nupkg -Repository CompanyFeed

PARAMETERS

-ApiKey

API key used by NuGet-compatible package publish endpoints.

Type: String
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: NuGetApiKey
Possible values:

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

-ApiKeyFilePath

Optional path to a file containing the API key.

Type: String
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: ApiKeyPath, NuGetApiKeyPath
Possible values:

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

-Authors

Optional authors override.

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

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

-Credential

Optional repository credential.

Type: PSCredential
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: None
Possible values:

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

-Description

Optional description override.

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

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

-Force

Overwrite an existing package.

Type: SwitchParameter
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: None
Possible values:

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

-ManifestPath

Optional explicit module manifest path.

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

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

-Name

Optional package id override.

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

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

-NupkgPath

Existing .nupkg file to publish without repacking a module folder.

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

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

-OutputDirectory

Directory that receives the created or supplied package; it is also the local target when Repository is omitted.

Type: String
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: DestinationPath, OutputPath
Possible values:

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

-Path

Module folder to package.

Type: String
Parameter Sets: PathParameterSet
Aliases: ModulePath
Possible values:

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

-ProfileName

Saved module repository profile to use instead of Repository or OutputDirectory.

Type: String
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: None
Possible values:

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

-ProjectUrl

Optional project URL override.

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

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

-Proxy

Optional HTTP proxy used for repository requests.

Type: Uri
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: None
Possible values:

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

-ProxyCredential

Optional proxy credential used with Proxy.

Type: PSCredential
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: None
Possible values:

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

-Repository

Repository URL, NuGet v3 service index, publish endpoint, or local folder feed.

Type: String
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: RepositoryPath, RepositoryUri, Source
Possible values:

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

-RepositoryName

Friendly repository name used in output.

Type: String
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: None
Possible values:

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

-ShowSummary

Write a compact Spectre.Console summary for the publish result.

Type: SwitchParameter
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: None
Possible values:

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

-SkipDependenciesCheck

Skip checking RequiredModules against the target repository.

Type: SwitchParameter
Parameter Sets: PathParameterSet, NupkgPathParameterSet
Aliases: None
Possible values:

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

-SkipModuleManifestValidate

Skip managed manifest metadata validation before packaging.

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

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

-Tags

Optional package tags override.

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

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

-Version

Optional package version override.

Type: String
Parameter Sets: PathParameterSet
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.ManagedModulePublishResult

RELATED LINKS

• None