NetboxPS/deploy.ps1

<#
    .SYNOPSIS
        Concatenate files into single PSM1 and PSD1 files

    .DESCRIPTION
        Concatenate all ps1 files in the Functions directory, plus the root PSM1,
        into a single PSM1 file in the NetboxPS directory.

        By default, this script will increment version by 0.0.1

    .PARAMETER SkipVersion
        Do not increment the version.

    .PARAMETER VersionIncrease
        Increase the version by a user defined amount

    .PARAMETER NewVersion
        Override the new version with this version

    .PARAMETER Environment
        A description of the Environment parameter.

    .PARAMETER ResetCurrentEnvironment
        A description of the ResetCurrentEnvironment parameter.

    .EXAMPLE
        Use all defaults and concatenate all files

        .\deploy.ps1

    .EXAMPLE
        Increment the version by 0.2.0. Given version 1.2.0, the resulting version will be 1.4.0

        .\deploy.ps1 -VersionIncrease 0.2.0
#>
[CmdletBinding(DefaultParameterSetName = 'IncreaseVersion')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingWriteHost", "")]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "")]
param
(
    [Parameter(ParameterSetName = 'SkipVersion')]
    [switch]$SkipVersion,

    [Parameter(ParameterSetName = 'IncreaseVersion')]
    [version]$VersionIncrease = "0.0.1",

    [Parameter(ParameterSetName = 'SetVersion')]
    [version]$NewVersion,

    [ValidateSet('dev', 'development', 'prod', 'production', IgnoreCase = $true)]
    [string]$Environment = 'development',
    [switch]$ResetCurrentEnvironment
)

Write-Host "Beginning deployment" -ForegroundColor Green
Write-Host "Importing required modules" -ForegroundColor Green

Import-Module "PSScriptAnalyzer", "Microsoft.PowerShell.Utility" -ErrorAction Stop


$ModuleName = 'NetboxPS'
$ConcatenatedFilePath = "$PSScriptRoot\concatenated.ps1"
$FunctionPath = "$PSScriptRoot\Functions"
$OutputDirectory = "$PSScriptRoot\$ModuleName"
$PSD1OutputPath = "$OutputDirectory\$ModuleName.psd1"
$PSM1OutputPath = "$OutputDirectory\$ModuleName.psm1"
$PS1FunctionFiles = Get-ChildItem $FunctionPath -Filter "*.ps1" -Recurse | Sort-Object Name


Write-Host "Removing whitespace from files" -ForegroundColor Green
Invoke-ScriptAnalyzer -Path $FunctionPath -IncludeRule 'PSAvoidTrailingWhitespace' -Recurse -Fix


Write-Host "Concatenating [$($PS1FunctionFiles.Count)] PS1 files from $FunctionPath"

"" | Out-File -FilePath $ConcatenatedFilePath -Encoding utf8

$Counter = 0
foreach ($File in $PS1FunctionFiles) {
    $Counter++

    try {
        Write-Host (" Adding file {0:D2}/{1:D2}: $($File.Name)" -f $Counter, $PS1FunctionFiles.Count)

        "`r`n#region File $($File.Name)`r`n" | Out-File -FilePath $ConcatenatedFilePath -Encoding utf8 -Append -ErrorAction Stop

        Get-Content $File.FullName -Encoding UTF8 -ErrorAction Stop | Out-File -FilePath $ConcatenatedFilePath -Encoding utf8 -Append -ErrorAction Stop

        "`r`n#endregion" | Out-File -FilePath $ConcatenatedFilePath -Encoding utf8 -Append -ErrorAction Stop
    } catch {
        Write-Host "FAILED TO WRITE CONCATENATED FILE: $($_.Exception.Message): $($_.TargetObject)" -ForegroundColor Red
        return
    }
}

"" | Out-File -FilePath $ConcatenatedFilePath -Encoding utf8 -Append


Write-Host " Adding psm1"
Get-Content "$PSScriptRoot\$ModuleName.psm1" | Out-File -FilePath $ConcatenatedFilePath -Encoding UTF8 -Append


$PSDManifest = Import-PowerShellDataFile -Path "$PSScriptRoot\$ModuleName.psd1"
# Get the version from the PSD1
[version]$CurrentVersion = $PSDManifest.ModuleVersion

$UpdateModuleManifestSplat = @{
    Path              = "$PSScriptRoot\$ModuleName.psd1"
    ErrorAction       = 'Stop'
}

if ($Environment -ilike 'dev*') {
    Write-Host "Exporting all functions for development"
    $UpdateModuleManifestSplat['FunctionsToExport'] = $PS1FunctionFiles.BaseName
} else {
    $UpdateModuleManifestSplat['FunctionsToExport'] = ($PS1FunctionFiles.BaseName | Where-Object { $_ -like '*-*' })
}


Write-Host "Comparing versions"
switch ($PSCmdlet.ParameterSetName) {
    "SkipVersion" {
        # Dont do anything with the PSD
        Write-Host " Skipping version update, maintaining version [$CurrentVersion]"

        break
    }

    "IncreaseVersion" {
        # Calculate the new version
        [version]$NewVersion = "{0}.{1}.{2}" -f ($CurrentVersion.Major + $VersionIncrease.Major), ($CurrentVersion.Minor + $VersionIncrease.Minor), ($CurrentVersion.Build + $VersionIncrease.Build)

        Write-Host " Updating version from [$CurrentVersion] to [$NewVersion]"

        # Replace the version number in the content
        $UpdateModuleManifestSplat['ModuleVersion'] = $NewVersion

        break
    }

    "SetVersion" {
        Write-Host " Updating version from [$CurrentVersion] to [$NewVersion]"

        # Replace the version number in the content
        $UpdateModuleManifestSplat['ModuleVersion'] = $NewVersion

        break
    }
}


Write-Host "Updating Module Manifest"
Update-ModuleManifest @UpdateModuleManifestSplat

Write-Host " Removing trailing whitespaces from psd1"
Invoke-ScriptAnalyzer -Path $UpdateModuleManifestSplat.Path -IncludeRule 'PSAvoidTrailingWhitespace' -Fix


if (-not (Test-Path $OutputDirectory)) {
    try {
        Write-Warning "Creating output directory [$OutputDirectory]"
        $null = New-Item -Path $OutputDirectory -ItemType Directory -Force
    } catch {
        throw "Failed to create output directory [$OutputDirectory]: $($_.Exception.Message)"
    }
}


Write-Host " Copying psd1"
Copy-Item -Path "$PSScriptRoot\$ModuleName.psd1" -Destination $PSD1OutputPath -Force

Write-Host " Copying psm1"
Copy-Item -Path $ConcatenatedFilePath -Destination $PSM1OutputPath -Force


Write-Host "Deployment complete" -ForegroundColor Green
if ($ResetCurrentEnvironment) {
    Write-Warning "Running commands to reset current environment"
    if (Get-Module 'NetboxPS') {
        Remove-Module NetboxPS -Force
    }

    Write-Host " Reimporting module"
    Import-Module $PSM1OutputPath, $PSD1OutputPath -Force -ErrorAction Stop

    Write-Host "Reset complete" -ForegroundColor Green
}