IB.tasks.ps1
|
Remove-Variable -Name PSBPreference -Scope Script -Force -ErrorAction Ignore Set-Variable -Name PSBPreference -Option ReadOnly -Scope Script -Value (. ([IO.Path]::Combine($PSScriptRoot, 'build.properties.ps1'))) $__DefaultBuildDependencies = $PSBPreference.Build.Dependencies # Synopsis: Initialize build environment variables task Init { Initialize-PSBuild -UseBuildHelpers -BuildEnvironment $PSBPreference } # Synopsis: Clears module output directory task Clean Init, { Clear-PSBuildOutputFolder -Path $PSBPreference.Build.ModuleOutDir } # Synopsis: Builds module based on source directory task StageFiles Clean, { $buildParams = @{ Path = $PSBPreference.General.SrcRootDir ModuleName = $PSBPreference.General.ModuleName DestinationPath = $PSBPreference.Build.ModuleOutDir Exclude = $PSBPreference.Build.Exclude Compile = $PSBPreference.Build.CompileModule CompileDirectories = $PSBPreference.Build.CompileDirectories CopyDirectories = $PSBPreference.Build.CopyDirectories Culture = $PSBPreference.Help.DefaultLocale } if ($PSBPreference.Help.ConvertReadMeToAboutHelp) { $readMePath = Get-ChildItem -Path $PSBPreference.General.ProjectRoot -Include 'readme.md', 'readme.markdown', 'readme.txt' -Depth 1 | Select-Object -First 1 if ($readMePath) { $buildParams.ReadMePath = $readMePath } } # only add these configuration values to the build parameters if they have been been set 'CompileHeader', 'CompileFooter', 'CompileScriptHeader', 'CompileScriptFooter' | ForEach-Object { if ($PSBPreference.Build.Keys -contains $_) { $buildParams.$_ = $PSBPreference.Build.$_ } } Build-PSBuildModule @buildParams } $analyzePreReqs = { $result = $true if (-not $PSBPreference.Test.ScriptAnalysis.Enabled) { Write-Warning 'Script analysis is not enabled.' $result = $false } if (-not (Get-Module -Name PSScriptAnalyzer -ListAvailable)) { Write-Warning 'PSScriptAnalyzer module is not installed' $result = $false } $result } # Synopsis: Execute PSScriptAnalyzer tests task Analyze -If (. $analyzePreReqs) Build,{ $analyzeParams = @{ Path = $PSBPreference.Build.ModuleOutDir SeverityThreshold = $PSBPreference.Test.ScriptAnalysis.FailBuildOnSeverityLevel SettingsPath = $PSBPreference.Test.ScriptAnalysis.SettingsPath } Test-PSBuildScriptAnalysis @analyzeParams } $pesterPreReqs = { $result = $true if (-not $PSBPreference.Test.Enabled) { Write-Warning 'Pester testing is not enabled.' $result = $false } if (-not (Get-Module -Name Pester -ListAvailable)) { Write-Warning 'Pester module is not installed' $result = $false } if (-not (Test-Path -Path $PSBPreference.Test.RootDir)) { Write-Warning "Test directory [$($PSBPreference.Test.RootDir)] not found" $result = $false } return $result } # Synopsis: Execute Pester tests task Pester -If (. $pesterPreReqs) Build,{ $pesterParams = @{ Path = $PSBPreference.Test.RootDir ModuleName = $PSBPreference.General.ModuleName ModuleManifest = Join-Path $PSBPreference.Build.ModuleOutDir "$($PSBPreference.General.ModuleName).psd1" OutputPath = $PSBPreference.Test.OutputFile OutputFormat = $PSBPreference.Test.OutputFormat CodeCoverage = $PSBPreference.Test.CodeCoverage.Enabled CodeCoverageThreshold = $PSBPreference.Test.CodeCoverage.Threshold CodeCoverageFiles = $PSBPreference.Test.CodeCoverage.Files CodeCoverageOutputFile = $PSBPreference.Test.CodeCoverage.OutputFile CodeCoverageOutputFileFormat = $PSBPreference.Test.CodeCoverage.OutputFormat ImportModule = $PSBPreference.Test.ImportModule } Test-PSBuildPester @pesterParams } $genMarkdownPreReqs = { $result = $true if (-not (Get-Module platyPS -ListAvailable)) { Write-Warning "platyPS module is not installed. Skipping [$($task.name)] task." $result = $false } $result } # Synopsis: Generates PlatyPS markdown files from module help task GenerateMarkdown -if (. $genMarkdownPreReqs) StageFiles,{ $buildMDParams = @{ ModulePath = $PSBPreference.Build.ModuleOutDir ModuleName = $PSBPreference.General.ModuleName DocsPath = $PSBPreference.Docs.RootDir Locale = $PSBPreference.Help.DefaultLocale } Build-PSBuildMarkdown @buildMDParams } $genHelpFilesPreReqs = { $result = $true if (-not (Get-Module platyPS -ListAvailable)) { Write-Warning "platyPS module is not installed. Skipping [$($task.name)] task." $result = $false } $result } # Synopsis: Generates MAML-based help from PlatyPS markdown files task GenerateMAML -if (. $genHelpFilesPreReqs) GenerateMarkdown, { Build-PSBuildMAMLHelp -Path $PSBPreference.Docs.RootDir -DestinationPath $PSBPreference.Build.ModuleOutDir } $genUpdatableHelpPreReqs = { $result = $true if (-not (Get-Module platyPS -ListAvailable)) { Write-Warning "platyPS module is not installed. Skipping [$($task.name)] task." $result = $false } $result } # Synopsis: Create updatable help .cab file based on PlatyPS markdown help task GenerateUpdatableHelp -if (. $genUpdatableHelpPreReqs) BuildHelp, { Build-PSBuildUpdatableHelp -DocsPath $PSBPreference.Docs.RootDir -OutputPath $PSBPreference.Help.UpdatableHelpOutDir } # Synopsis: Publish module to the defined PowerShell repository Task Publish Test, { Assert ($PSBPreference.Publish.PSRepositoryApiKey -or $PSBPreference.Publish.PSRepositoryCredential) "API key or credential not defined to authenticate with [$($PSBPreference.Publish.PSRepository)] with." $publishParams = @{ Path = $PSBPreference.Build.ModuleOutDir Version = $PSBPreference.General.ModuleVersion Repository = $PSBPreference.Publish.PSRepository Verbose = $true #$VerbosePreference } if ($PSBPreference.Publish.PSRepositoryApiKey) { $publishParams.ApiKey = $PSBPreference.Publish.PSRepositoryApiKey } if ($PSBPreference.Publish.PSRepositoryCredential) { $publishParams.Credential = $PSBPreference.Publish.PSRepositoryCredential } Publish-PSBuildModule @publishParams } #region Summary Tasks # Synopsis: Builds help documentation task BuildHelp GenerateMarkdown,GenerateMAML Task Build { if ([String]$PSBPreference.Build.Dependencies -ne [String]$__DefaultBuildDependencies) { throw [NotSupportedException]'You cannot use $PSBPreference.Build.Dependencies with Invoke-Build. Please instead redefine the build task or your default task to include your dependencies. Example: Task . Dependency1,Dependency2,Build,Test or Task Build Dependency1,Dependency2,StageFiles' } },StageFiles,BuildHelp # Synopsis: Execute Pester and ScriptAnalyzer tests task Test Analyze,Pester task . Build,Test #endregion Summary Tasks |