PowerShellBuild

0.2.0

IB.tasks.ps1


# Load in build settings
 . (Join-Path -Path $PSScriptRoot -ChildPath build.properties.ps1)

# Synopsis: Initialize Invoke-Build
task init {
    Initialize-PSBuild -UseBuildHelpers
}

# Synopsis: Clean output directory
task Clean init, {
    Clear-PSBuildOutputFolder -Path $moduleOutDir
}

# Synopsis: Build module
task StageFiles Clean, {
    $buildParams = @{
        Path               = $srcRootDir
        DestinationPath    = $moduleOutDir
        ModuleName         = $moduleName
        Exclude            = $Exclude
        Compile            = $compileModule
        Culture            = $defaultLocale
    }

    if ($convertReadMeToAboutHelp) {
        $readMePath = Get-ChildItem -Path $projectRoot -Include 'readme.md', 'readme.markdown', 'readme.txt' -Depth 1 |
            Select-Object -First 1
        if ($readMePath) {
            $buildParams.ReadMePath = $readMePath
        }
    }
    Build-PSBuildModule @buildParams
}

# Synopsis: Build module
task Build StageFiles, BuildHelp

# Synopsis: Execute PSScriptAnalyzer tests
task Analyze -if $scriptAnalysisEnabled Build, {
    $analyzeParams = @{
        Path              = $moduleOutDir
        SeverityThreshold = $scriptAnalysisFailBuildOnSeverityLevel
        SettingsPath      = $scriptAnalyzerSettingsPath
    }
    Test-PSBuildScriptAnalysis @analyzeParams
}

# Synopsis: Execute Pester tests
task Pester Build, {
    $pesterParams = @{
        Path                  = $testRootDir
        ModuleName            = $moduleName
        OutputPath            = $testOutputFile
        OutputFormat          = $testOutputFormat
        CodeCoverage          = $codeCoverageEnabled
        CodeCoverageThreshold = $codeCoverageThreshold
        CodeCoverageFiles     = $codeCoverageFiles
    }
    Test-PSBuildPester @pesterParams
}

# Synopsis: Execute Pester and ScriptAnalyzer tests
task Test Pester, Analyze

# Synopsis: Build the module, including help
task BuildHelp GenerateMarkdown, GenerateMAML

# Synopsis: Generate markdown help documentation using PlatyPS
task GenerateMarkdown StageFiles, {
    Build-PSBuildMarkdown -ModulePath $moduleOutDir -ModuleName $moduleName -DocsPath $docsRootDir -Locale $defaultLocale
}

# Synopsis: Generate module MAML help from markdown source
task GenerateMAML GenerateMarkdown, {
    Build-PSBuildMAMLHelp -Path $docsRootDir -DestinationPath $moduleOutDir
}

task GenerateUpdatableHelp -If $genUpdatableHelpPreReqs BuildHelp, {
    Build-PSBuildUpdatableHelp -DocsPath $docsRootDir -OutputPath $updatableHelpOutDir
}

task Publish Test, {
    Assert -Condition ($psRepositoryApiKey -or $psRepositoryCredential) -Message "API key or credential not defined to authenticate with $psRepository with."

    $publishParams = @{
        Path       = $moduleOutDir
        Version    = $moduleVersion
        Repository = $psRepository
        Verbose    = $VerbosePreference
    }
    if ($psRepositoryApiKey) {
        $publishParams.ApiKey = $psRepositoryApiKey
    } else {
        $publishParams.Credential = $psRepositoryCredential
    }

    Publish-PSBuildModule @publishParams
}

task . Build