Functions/Helper/Publish-IBHGallery.ps1
|
<#
.SYNOPSIS Publish the module to the PowerShell Gallery. .DESCRIPTION Use the build-in Publish-Module command to publish a new module version including the release notes. .OUTPUTS None. No output if successful or an exception in case of an error. .EXAMPLE PS C:\> Publish-IBHGallery -BuildRoot 'C:\GitHub\InvokeBuildHelper' -ModuleName 'InvokeBuildHelper' -ModuleVersion '1.0.0' -GalleryName 'PSGallery' -GalleryUser $user -GalleryToken $token Publish the module InvokeBuildHelper version 1.0.0 to the PSGallery. .LINK https://github.com/claudiospizzi/PSInvokeBuildHelperer #> function Publish-IBHGallery { [CmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'GalleryUser', Justification = 'Not yet in use')] param ( # Root path of the project. [Parameter(Mandatory = $true)] [System.String] $BuildRoot, # Name of the module. [Parameter(Mandatory = $true)] [System.String] $ModuleName, # Version to publish. [Parameter(Mandatory = $true)] [System.String] $ModuleVersion, # Gallery name. [Parameter(Mandatory = $true)] [System.String] $GalleryName, # Gallery user. [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $GalleryUser, # Gallery token. [Parameter(Mandatory = $true)] [System.Security.SecureString] $GalleryToken ) $releaseNotes = Get-IBHModuleReleaseNote -BuildRoot $BuildRoot -ModuleVersion $ModuleVersion # Unprotect token $tokenCredentialStub = [System.Management.Automation.PSCredential]::new('Token', $GalleryToken) $plainToken = $tokenCredentialStub.GetNetworkCredential().Password # Publish to the Gallery Publish-Module -Path "$BuildRoot\$ModuleName" -Repository $GalleryName -NuGetApiKey $plainToken -ReleaseNotes $releaseNotes -Force } |