Public/build/Helpers/Invoke-MsBuild.ps1
|
<#
The MIT License (MIT) Copyright (c) 2015 Objectivity Bespoke Software Specialists Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #> function Invoke-MsBuild { <# .SYNOPSIS Invokes msbuild to build the specified project, using given version of msbuild (or the latest one if not specified). .PARAMETER ProjectPath Path to the project to build. .PARAMETER RestoreNuGet If true, 'nuget restore' will be explicitly run before building the project file. .PARAMETER MsBuildOptions An object created by New-MsBuildOptions function, which specifies msbuild options. If not provided, default msbuild options will be used. .PARAMETER Version Version number that will be written to the AssemblyInfo files. .PARAMETER AssemblyInfoFilePaths Paths to AssemblyInfo files which will have their version numbers updated. .PARAMETER LogExternalMessage If true, external progress message will be logged (this needs to be set to false when invoked internally). .EXAMPLE Invoke-MsBuild -ProjectPath $projectPath -MsBuildOptions $MsBuildOptions #> [CmdletBinding()] [OutputType([void])] param( [Parameter(Mandatory=$true)] [string] $ProjectPath, [Parameter(Mandatory=$false)] [switch] $RestoreNuGet, [Parameter(Mandatory=$false)] [PSObject] $MsBuildOptions, [Parameter(Mandatory=$false)] [string] $Version, [Parameter(Mandatory=$false)] [string[]] $AssemblyInfoFilePaths, [Parameter(Mandatory=$false)] [switch] $LogExternalMessage = $true ) if ($LogExternalMessage) { $projectFile = Split-Path -Path $ProjectPath -Leaf Write-ProgressExternal -Message "Running msbuild - $projectFile" -ErrorMessage 'Msbuild error' } # Take default MsBuildOptions if not provided if (!$MsBuildOptions) { $MsBuildOptions = New-MsBuildOptions } $ProjectPath = Resolve-PathRelativeToProjectRoot -Path $ProjectPath if ($Version) { if (!$AssemblyInfoFilePaths) { if (Test-Path -LiteralPath $ProjectPath -PathType Leaf) { $projectDir = Split-Path -Path $ProjectPath -Parent } else { $projectDir = $ProjectPath } Write-Log -Info "AssemblyInfoFiles not defined - setting version in all *AssemblyInfo.cs files under '$projectDir'" $AssemblyInfoFilePaths = Get-ChildItem -LiteralPath $projectDir -Filter '*AssemblyInfo.cs' -Recurse | Select-Object -ExpandProperty FullName } if (!$AssemblyInfoFilePaths) { Write-Log -Warn "No AssemblyInfo files found" } else { Set-AssemblyVersion -Path $AssemblyInfoFilePaths -Version $Version -VersionAttribute AssemblyVersion,AssemblyFileVersion -CreateBackup } } if ($RestoreNuGet) { Write-Log -Info "Restoring nuget packages for project '$ProjectPath'." -Emphasize Start-NugetRestore -ProjectPath $ProjectPath } $Targets = $MsBuildOptions.Targets $Configuration = $MsBuildOptions.Configuration $MsBuildProperties = $MsBuildOptions.MsBuildProperties $VisualStudioVersion = $MsBuildOptions.VisualStudioVersion $MsBuildVersion = $MsBuildOptions.MsBuildVersion $MsBuildForceArchitecture = $MsBuildOptions.MsBuildForceArchitecture $msbuildPath = Get-MsBuildPath -VisualStudioVersion $VisualStudioVersion -MsBuildVersion $MsBuildVersion -ForceArchitecture $MsBuildForceArchitecture if (!$msbuildPath) { if (!$MsBuildForceArchitecture) { $MsBuildForceArchitecture = "(default)" } if (!$VisualStudioVersion -and !$MsBuildVersion) { throw "Cannot find any version of msbuild." } if ($VisualStudioVersion) { throw "Cannot find msbuild for Visual Studio Version = '$VisualStudioVersion', architecture = '$MsBuildForceArchitecture'." } throw "Cannot find msbuild version = '$MsBuildVersion', architecture = '$MsBuildForceArchitecture'." } $cmd = Add-QuotesToPaths -Paths $msbuildPath $cmd += " " + (Add-QuotesToPaths -Paths $ProjectPath) foreach ($target in $Targets) { $cmd += " /t:`"$target`"" } if ($Configuration) { $cmd += " /p:Configuration=`"$Configuration`"" } if ($MsBuildProperties) { foreach ($property in $MsBuildProperties.GetEnumerator()) { $cmd += (" /p:{0}=`"{1}`"" -f ($property.Key), ($property.Value)) } } if ($VisualStudioVersion) { $vsVersionMap = @{ ` "2008" = "9.0"; ` "2010" = "10.0"; ` "2012" = "11.0"; ` "2013" = "12.0"; ` "2015" = "14.0"; ` "2017" = "15.0" } $vsVersion = $vsVersionMap[$VisualStudioVersion] $cmd += " /p:VisualStudioVersion=`"${vsVersion}`"" } # maxcpucount - use all available cpus # nodeReuse - kill msbuild.exe process after finishing (without it issues with directory locking can occur) $cmd += ' /nologo /maxcpucount /nodeReuse:false' if ($MsBuildOptions.Quiet) { $cmd += ' /v:q /clp:ErrorsOnly;Summary' } if ($MsBuildOptions.MsBuildCmdLineArguments) { foreach ($param in $MsBuildOptions.MsBuildCmdLineArguments) { $cmd += " $param" } } # note: don't put [void] / Out-Null here as we need to write output Invoke-ExternalCommand -Command $cmd -DontCatchOutputStreams -ReturnLastExitCode:$false if ($Version) { Restore-AssemblyVersionBackups -Path $AssemblyInfoFilePaths } if ($LogExternalMessage) { Write-ProgressExternal -Message '' -ErrorMessage '' } } |