templates/dotnetbuild.tmpl.ps1
|
#Requires -Version 7 <# .SYNOPSIS Runs a .NET flavoured build process. .DESCRIPTION This script was scaffolded using a template from the Endjin.RecommendedPractices.Build PowerShell module. It uses the InvokeBuild module to orchestrate an opinonated software build process for .NET solutions. .EXAMPLE PS C:\> ./build.ps1 Downloads any missing module dependencies (Endjin.RecommendedPractices.Build & InvokeBuild) and executes the build process. .PARAMETER Tasks Optionally override the default task executed as the entry-point of the build. .PARAMETER Configuration The build configuration, defaults to 'Release'. .PARAMETER BuildRepositoryUri Optional URI that supports pulling MSBuild logic from a web endpoint (e.g. a GitHub blob). .PARAMETER SourcesDir The path where the source code to be built is located, defaults to the current working directory. .PARAMETER CoverageDir The output path for the test coverage data, if run. .PARAMETER TestReportTypes The test report format that should be generated by the test report generator, if run. .PARAMETER PackagesDir The output path for any packages produced as part of the build. .PARAMETER LogLevel The logging verbosity. .PARAMETER Clean When true, the .NET solution will be cleaned and all output/intermediate folders deleted. .PARAMETER BuildModulePath The path to import the Endjin.RecommendedPractices.Build module from. This is useful when testing pre-release versions of the Endjin.RecommendedPractices.Build that are not yet available in the PowerShell Gallery. .PARAMETER BuildModuleVersion The version of the Endjin.RecommendedPractices.Build module to import. This is useful when testing pre-release versions of the Endjin.RecommendedPractices.Build that are not yet available in the PowerShell Gallery. .PARAMETER InvokeBuildModuleVersion The version of the InvokeBuild module to be used. #> [CmdletBinding()] param ( [Parameter(Position=0)] [string[]] $Tasks = @("."), [Parameter()] [string] $Configuration = "Debug", [Parameter()] [string] $BuildRepositoryUri = "", [Parameter()] [string] $SourcesDir = $PWD, [Parameter()] [string] $CoverageDir = "_codeCoverage", [Parameter()] [string] $TestReportTypes = "Cobertura", [Parameter()] [string] $PackagesDir = "_packages", [Parameter()] [ValidateSet("minimal","normal","detailed")] [string] $LogLevel = "minimal", [Parameter()] [switch] $Clean, [Parameter()] [string] $BuildModulePath, [Parameter()] [version] $BuildModuleVersion = "<%= $((Get-Module Endjin.RecommendedPractices.Build | Select-Object -ExpandProperty Version).ToString())%>", [Parameter()] [version] $InvokeBuildModuleVersion = "<%= $InvokeBuildModuleVersion %>" ) $ErrorActionPreference = $ErrorActionPreference ? $ErrorActionPreference : 'Stop' $InformationPreference = 'Continue' $here = Split-Path -Parent $PSCommandPath #region InvokeBuild setup if (!(Get-Module -ListAvailable InvokeBuild)) { Install-Module InvokeBuild -RequiredVersion $InvokeBuildModuleVersion -Scope CurrentUser -Force -Repository PSGallery } Import-Module InvokeBuild # This handles calling the build engine when this file is run like a normal PowerShell script # (i.e. avoids the need to have another script to setup the InvokeBuild environment and issue the 'Invoke-Build' command ) if ($MyInvocation.ScriptName -notlike '*Invoke-Build.ps1') { try { Invoke-Build $Tasks $MyInvocation.MyCommand.Path @PSBoundParameters } catch { $_.ScriptStackTrace throw } return } #endregion #region Import shared tasks and initialise build framework if (!($BuildModulePath)) { if (!(Get-Module -ListAvailable Endjin.RecommendedPractices.Build | ? { $_.Version -eq $BuildModuleVersion })) { Write-Information "Installing 'Endjin.RecommendedPractices.Build' module..." Install-Module Endjin.RecommendedPractices.Build -RequiredVersion $BuildModuleVersion -Scope CurrentUser -Force -Repository PSGallery } $BuildModulePath = "Endjin.RecommendedPractices.Build" } else { Write-Information "BuildModulePath: $BuildModulePath" } Import-Module $BuildModulePath -RequiredVersion $BuildModuleVersion -Force # Load the build process & tasks . Endjin.RecommendedPractices.Build.tasks #endregion # # Build process control options # $SkipInit = $false $SkipVersion = $false $SkipBuild = $false $CleanBuild = $Clean $SkipTest = $false $SkipTestReport = $false $SkipAnalysis = $false $SkipPackage = $false $SkipPublish = $false # NOTE: Install the 'Endjin.RecommendedPractices.Build' VS Code extension to get handy # snippets for enabling & configuring features in this build script. # Once installed <CTRL-ALT-J> will open the snippet picker and you can type 'build' # to see the available snippets. # # Build process configuration # $SolutionToBuild = (Resolve-Path (Join-Path $here "<%= $SolutionPath %>")).Path $ProjectsToPublish = @( # "Solutions/MySolution/MyWebSite/MyWebSite.csproj" ) $NuSpecFilesToPackage = @( # "Solutions/MySolution/MyProject/MyProject.nuspec" ) # # Specify files to exclude from code coverage # This option is for excluding generated code # - Use file path or directory path with globbing (e.g dir1/*.cs) # - Use single or multiple paths (separated by comma) (e.g. **/dir1/class1.cs,**/dir2/*.cs,**/dir3/**/*.cs) # $ExcludeFilesFromCodeCoverage = "" # Synopsis: Build, Test and Package task . FullBuild # build extensibility tasks task RunFirst {} task PreInit {} task PostInit {} task PreVersion {} task PostVersion {} task PreBuild {} task PostBuild {} task PreTest {} task PostTest {} task PreTestReport {} task PostTestReport {} task PreAnalysis {} task PostAnalysis {} task PrePackage {} task PostPackage {} task PrePublish {} task PostPublish {} task RunLast {} |