Publish-StagedArtifact.ps1

<#
.Synopsis
    Publishes the AWSPowerShell, AWSPowerShell.NetCore, and AWS.Tools.* modules 
    to the PowerShell Gallery or a local PowerShell repository.
.DESCRIPTION
    Publishes the AWS Tools for PowerShell modules (AWSPowerShell, 
    AWSPowerShell.NetCore, and AWS.Tools.*) to the PowerShell Gallery or a 
    local PowerShell repository.

.NOTES
    The script must be run in a folder that contains subfolders holding the 
    modules to be published (i.e. .\AWSPowerShell, .\AWSPowerShell.NetCore, and
    .\AWS.Tools).

    Publishing is done using the Publish-PSResource cmdlet of the PSResourceGet 
    module. This module must be installed either in user scope or globally 
    before this script can be used.

    To publish to the gallery an API key, similar to NuGet, is required. The 
    key is available in Secrets Manager. For a local PowerShell repository the
    API key is passed to this script.

.EXAMPLE
    Publish-StagedArtifact -SecretId the-secret-id 
        -SecretRegion the-secret-region 
        -SecretReaderProfile the-secret-reader-profile 
        -SecretKey the-secret-key-name 
        -UpdatePackageVersionsProfile the-updated-package-versions-profile
    
	Publishes all modules to the PowerShell Gallery.

.EXAMPLE
    Publish-StagedArtifact -SecretId the-secret-id 
        -SecretRegion the-secret-region 
        -SecretReaderProfile the-secret-reader-profile 
        -SecretKey the-secret-key-name 
        -UpdatePackageVersionsProfile the-updated-package-versions-profile
        -DryRun
    	
    Displays the changelog notes and file paths the script would operate on, but does not
    push the modules to the PowerShell Gallery.

.EXAMPLE
    Publish-StagedArtifact -LocalRepositoryName local-repository-name
        -LocalRepositoryNuGetApiKey local-repository-nuget-api-key

	Publishes all modules to the local PowerShell Gallery.
#>

[CmdletBinding()]
Param
(
    [Parameter(ParameterSetName="remote", Mandatory = $true, HelpMessage = "The name of the Secrets Manager secret containing the PowerShell Gallery key.")]
    [ValidateNotNullOrEmpty()]
    [string]$SecretId,

    [Parameter(ParameterSetName="remote", Mandatory = $true, HelpMessage = "The AWS region where the PowerShell Gallery key is available from Secrets Manager.")]
    [ValidateNotNullOrEmpty()]
    [string]$SecretRegion,
    
    [Parameter(ParameterSetName="remote", Mandatory = $true, HelpMessage = "The AWS profile to use to retrieve the PowerShell Gallery key from Secrets Manager.")]
    [ValidateNotNullOrEmpty()]
    [string]$SecretReaderProfile,
    
    [Parameter(ParameterSetName="remote", Mandatory = $true, HelpMessage = "The name of entry of the PowerShell Gallery key in the Secret Manager secret.")]
    [ValidateNotNullOrEmpty()]
    [string]$SecretKey,

    [Parameter(ParameterSetName="remote", Mandatory = $true, HelpMessage = "The AWS profile to use to update and store PowerShell Gallery package information in the ProfileVersions table.")]
    [ValidateNotNullOrEmpty()]
    [string]$UpdatePackageVersionsProfile,
    
    [Parameter(ParameterSetName="remote")]    
    [string] $RequiredAWSPowerShellVersionToUse = '4.1.14.0',    

    [Parameter(ParameterSetName="remote")]
    [switch]$DryRun,

    [Parameter(ParameterSetName="local", Mandatory = $true, HelpMessage = "The name of the local PowerShell repository to publish to.")]
    [string]$LocalRepositoryName,

    [Parameter(ParameterSetName="local", Mandatory = $true, HelpMessage = "The local repository NuGetApiKey used for publishing to the local repository.")]
    [string]$LocalRepositoryNuGetApiKey
)

$ErrorActionPreference = "Stop"
$paramSetRemoteName = "remote"
$paramSetLocalName = "local"

Import-Module Microsoft.PowerShell.PSResourceGet

# in pwsh 7.1.0, running Publish-PSResource errors out with
# Cannot retrieve the dynamic parameters for the cmdlet. Loading repository store failed: Could not find file 'C:\Users\ContainerAdministrator\AppData\Local\PSResourceGet\PSResourceRepository.xml'.
# Running Get-PSResourceRepository seems to create the PSResourceRepository.xml file
$allRepos = Get-PSResourceRepository

#Import DynamoDBv2 needed to update the PackageVersions table.
if ($PSCmdlet.ParameterSetName -eq $paramSetRemoteName) {
    if (-not (Get-Module -ListAvailable -Name AWS.Tools.DynamoDBv2 | Where-Object { $_.Version -eq $RequiredAWSPowerShellVersionToUse })) {
        Write-Host "Installing AWS.Tools.DynamoDBv2 $RequiredAWSPowerShellVersionToUse"
        Install-Module -Name AWS.Tools.DynamoDBv2 -RequiredVersion $RequiredAWSPowerShellVersionToUse -Force
    }
    Import-Module -Name AWS.Tools.DynamoDBv2 -RequiredVersion $RequiredAWSPowerShellVersionToUse

    Import-Module $PSScriptRoot/Update-ModulePackageVersion.psm1
}
elseif($PSCmdlet.ParameterSetName -eq $paramSetLocalName){
    # validate if the LocalRepositoryName exists
    $localRepo = $allRepos | Where-Object {$_.Name -eq $LocalRepositoryName}
    if(-not $localRepo){
        throw "Local repository $LocalRepositoryName does not exist."
    }
}

$alreadyImportedModules = New-Object System.Collections.Generic.HashSet[string]

$currentLocation = (Get-Location).Path
$awsPowerShellModuleLocation = Join-Path $currentLocation "AWSPowerShell"
$awsPowerShellCoreModuleLocation = Join-Path $currentLocation "AWSPowerShell.NetCore"
$awsPowerShellModularModulesLocation = Join-Path $currentLocation "AWS.Tools"

if (-not $DryRun -and $PSCmdlet.ParameterSetName -eq $paramSetRemoteName) {
    #Import SecretsManager needed to get the secret key.
    if (-not (Get-Module -ListAvailable -Name AWS.Tools.SecretsManager | Where-Object { $_.Version -eq $RequiredAWSPowerShellVersionToUse })) {
        Write-Host "Installing AWS.Tools.SecretsManager $RequiredAWSPowerShellVersionToUse"
        Install-Module -Name AWS.Tools.SecretsManager -RequiredVersion $RequiredAWSPowerShellVersionToUse -Force
    }
    Import-Module -Name AWS.Tools.SecretsManager -RequiredVersion $RequiredAWSPowerShellVersionToUse

    $ApiKey = ((Get-SECSecretValue -SecretId $SecretId -Region $SecretRegion -ProfileName $SecretReaderProfile).SecretString | ConvertFrom-Json).$SecretKey
}

$commonArgs = @{
    'ApiKey'                     = $LocalRepositoryNuGetApiKey
    'SkipDependenciesCheck'      = $true
    'SkipModuleManifestValidate' = $true
    'Repository'                 = $LocalRepositoryName
}

if ($PSCmdlet.ParameterSetName -eq $paramSetRemoteName) {
    $commonArgs.ApiKey = $ApiKey
    $commonArgs.Repository = "PSGallery"
}

function PublishRecursive([string]$modulePath) {
    Write-Host "Analyzing $modulePath for publishing"

    if (-not (Test-Path $modulePath)) {
        throw "Expected path $modulePath does not exist"
    }

    $manifest = Get-ChildItem $modulePath -File -Filter *.psd1

    if ($manifest.Count -ne 1) {
        throw "Found $($manifest.Count) .psd1 files in $modulePath"
    }

    if ($alreadyImportedModules.Add($manifest.Name)) {
        $manifestData = Import-PowerShellDataFile $manifest.FullName
        
        foreach ($dependency in $manifestData.RequiredModules.ModuleName) {
            if ($dependency -like 'AWS.Tools.*') {
                $dependencyPath = Resolve-Path "$modulePath/../$dependency"
                PublishRecursive $dependencyPath
            }
        }

        #https://github.com/PowerShell/PowerShellGet/issues/523 Work around PowerShell Gallery eventual consistency
        $maxPublishRetries = 5
        for ($i = 0; $i -lt $maxPublishRetries; $i++) {
            try {
                Write-Host "Publishing $modulePath"
                if ($DryRun) {
                    Write-Host "-DryRun specified, skipped actual publish and PackageVersions update of $modulePath"
                }
                else {
                    Publish-PSResource -Path $modulePath @commonArgs
                    if($PSCmdlet.ParameterSetName -eq $paramSetRemoteName) {
                        Update-ModulePackageVersion -modulePath $modulePath -versionNumber $manifestData.ModuleVersion -repository "PSGallery" -profileName $UpdatePackageVersionsProfile
                    }
                    Write-Host "Published $modulePath"
                }                
                break
            }
            catch {
                #We could have failed because the module was already published (possible in case we run this script multiple times)
                if($PSCmdlet.ParameterSetName -eq $paramSetRemoteName) {
                    try {
                        Find-PSResource -Repository 'PSGallery' -Type 'Module' -Name ([System.IO.Path]::GetFileNameWithoutExtension($manifest)) -Version $manifestData.ModuleVersion
                        Write-Host "Successfully found module $modulePath version $($manifestData.ModuleVersion) already on the gallery"
                        if ($DryRun) {
                            Write-Host "-DryRun specified, skipped PackageVersions update of $modulePath in catch."
                        }
                        else {
                            Update-ModulePackageVersion -modulePath $modulePath -versionNumber $manifestData.ModuleVersion -repository "PSGallery" -profileName $UpdatePackageVersionsProfile
                        }
                        break;
                    }
                    catch {
                    }
                }

                Write-Host $_
                if ($i -lt $maxPublishRetries - 1) {
                    Write-Host "Error publishing $modulePath, retrying"
                    Start-Sleep -Seconds 5
                }
                else {
                    Write-Host "Fatal error publishing $modulePath"
                    throw  $_
                }
            }
        }
    }
    else {
        Write-Host "Skipping, $manifest already published"
    }
}

PublishRecursive $awsPowerShellModuleLocation
PublishRecursive $awsPowerShellCoreModuleLocation

$OldPath = $Env:PSModulePath
$Env:PSModulePath = $Env:PSModulePath + ";$awsPowerShellModularModulesLocation"

foreach ($module in Get-ChildItem $awsPowerShellModularModulesLocation -Directory) {
    PublishRecursive $module.FullName
}

$Env:PSModulePath = $OldPath