Commit aba7b5d2: Added CombineFunctionsAndStage, CreateReleaseArtifact, Clean build tasks

Added CombineFunctionsAndStage, CreateReleaseArtifact, Clean build tasks

aba7b5d2

Adam Rush

committed Dec 9, 2018

Files

Details



	Build
	build.psake.ps1

build.psake.ps1

-8+94

/Build/build.psake.ps1

View

$ProjectRoot = $PSScriptRoot

}

$Timestamp = Get-Date -UFormat "%Y%m%d-%H%M%S"

$Timestamp = Get-Date -UFormat '%Y%m%d-%H%M%S'

$PSVersion = $PSVersionTable.PSVersion.Major

$lines = '----------------------------------------------------------------------'

$Verbose = @{}

if ($ENV:BHCommitMessage -match "!verbose") {

$Verbose = @{Verbose = $True}

}

# Pester

$TestRootDir = "$ProjectRoot\Tests"

$TestScripts = Get-ChildItem "$ProjectRoot\Tests\*\*Tests.ps1"

$TestFile = "$($TimeStamp)_UnitTestResults.xml"

# Documentation

$DocumentationPath = Join-Path -Path $ProjectRoot -ChildPath 'Documentation'

# Build

$ArtifactFolder = Join-Path -Path $ProjectRoot -ChildPath 'Artifacts'

# Staging

$StagingFolder = Join-Path -Path $projectRoot -ChildPath 'Staging'

$StagingModulePath = Join-Path -Path $StagingFolder -ChildPath $env:BHProjectName

}

# Define top-level tasks

Task 'Default' -Depends 'Test'

Task 'Release' -Depends 'Clean', 'Test', 'UpdateDocumentation', 'CombineFunctionsAndStage', 'CreateReleaseArtifact' #'UpdateManifest', 'UpdateTag',

# Main tasks

Task 'Init' {

$lines

Set-Location $ProjectRoot

"`n"

}

Task 'Analyze' -Depends 'Init' {

$Results = Invoke-ScriptAnalyzer -Path $ENV:BHModulePath -Recurse -Settings $ScriptAnalyzerSettingsPath -Verbose:$VerbosePreference

}

Task 'Test' -Depends 'Analyze' {

$lines

"`nSTATUS: Testing with PowerShell $PSVersion"

# Gather test results. Store them in a variable and file

$TestFilePath = Join-Path -Path $ProjectRoot -ChildPath $TestFile

$TestFilePath = Join-Path -Path $ArtifactFolder -ChildPath $TestFile

$TestResults = Invoke-Pester -Script $TestScripts -PassThru -OutputFormat 'NUnitXml' -OutputFile $TestFilePath -PesterOption @{IncludeVSCodeMarker = $true}

# Upload test results to Appveyor

"`n"

}

Task 'Build' -Depends 'Test' {

$lines

}

Task 'Deploy' -Depends 'Build' {

$lines

Invoke-PSDeploy @Verbose @Params

}

Task 'UpdateDocumentation' -Depends 'Test' {

$lines

Write-Output "`nFINISHED: Updating Markdown help."

}

Task 'Clean' {

$lines

$foldersToClean = @(

$ArtifactFolder

$StagingFolder

)

# Remove folders

foreach ($folderPath in $foldersToClean) {

Remove-Item -Path $folderPath -Recurse -Force -ErrorAction 'SilentlyContinue'

New-Item -Path $folderPath -ItemType 'Directory' -Force | Out-String | Write-Verbose

}

Task 'CombineFunctionsAndStage' {

$lines

# Create folders

New-Item -Path $StagingFolder -ItemType 'Directory' -Force | Out-String | Write-Verbose

New-Item -Path $StagingModulePath -ItemType 'Directory' -Force | Out-String | Write-Verbose

# Get public and private function files

$publicFunctions = @( Get-ChildItem -Path "$env:BHModulePath\Public\*.ps1" -Recurse -ErrorAction 'SilentlyContinue' )

$privateFunctions = @( Get-ChildItem -Path "$env:BHModulePath\Private\*.ps1" -Recurse -ErrorAction 'SilentlyContinue' )

# Combine functions into a single .psm1 module

$combinedModulePath = Join-Path -Path $StagingModulePath -ChildPath "$($env:BHProjectName).psm1"

@($publicFunctions + $privateFunctions) | Get-Content | Add-Content -Path $combinedModulePath

# Copy other required folders and files

$pathsToCopy = @(

Join-Path -Path $ProjectRoot -ChildPath 'Documentation'

Join-Path -Path $ProjectRoot -ChildPath 'Examples'

# Join-Path -Path $ProjectRoot -ChildPath 'CHANGELOG.md'

Join-Path -Path $ProjectRoot -ChildPath 'README.md'

)

Copy-Item -Path $pathsToCopy -Destination $StagingFolder -Recurse

# Copy existing manifest

Copy-Item -Path $env:BHPSModuleManifest -Destination $StagingModulePath -Recurse

}

Task 'CreateReleaseArtifact' {

$lines

# Create /Release folder

New-Item -Path $ArtifactFolder -ItemType 'Directory' -Force | Out-String | Write-Verbose

# Get current manifest version

try {

$manifest = Test-ModuleManifest -Path $env:BHPSModuleManifest -ErrorAction 'Stop'

[Version]$manifestVersion = $manifest.Version

}

catch {

throw "Could not get manifest version from [$env:BHPSModuleManifest]"

}

# Create zip file

try {

$releaseFilename = "$env:BHProjectName-v$($manifestVersion.ToString()).zip"

$releasePath = Join-Path -Path $ArtifactFolder -ChildPath $releaseFilename

Write-Host "Creating release artifact [$releasePath] using manifest version [$manifestVersion]" -ForegroundColor 'Yellow'

Compress-Archive -Path "$StagingFolder/*" -DestinationPath $releasePath -Force -Verbose -ErrorAction 'Stop'

}

catch {

throw "Could not create release artifact [$releasePath] using manifest version [$manifestVersion]"

}

Write-Output "`nFINISHED: Release artifact creation."

}