MSBuild.PowerShell 1.0.2

MSBuild.PowerShell

Simplify the process of running your PowerShell code during MSBuild processes.

Features

There are 3 main Using Tasks that can be used to run PowerShell code:

1. <LocalPowerShellTask> - Runs a PowerShell script locally on the machine.
2. <RemotePowerShellTask> - Runs a PowerShell script on a remote machine.
3. <PowerShellTask> - Runs a PowerShell script either locally or remotely, depending on required parameters passed.

<LocalPowerShellTask>

This example is based off of the class library sample. It shows the following:

• Demonstrates running a PowerShell script locally in the MSBuild process.
• Runs the local example script.

<Target Name="TestLocalPowerShellTask" BeforeTargets="Build">
  <Message Text="Running Target 'TestLocalPowerShellTask' before build..." Importance="high" />
  <PropertyGroup>
    <TestParameters>
      TestMSBuildString = "$(Configuration)"
      TestString = 'Hello World Test' // Alternatively, use single quotes for strings
      TestBoolean = true
      TestNumber = 42
    </TestParameters>
  </PropertyGroup>
  <LocalPowerShellTask 
    ScriptFileName="HelloWorld.ps1" 
    ScriptFolderPath="$(MSBuildProjectDirectory)" // Root directory of the project
    Parameters="$(TestParameters)"
  />
</Target>

Local PowerShell Script Example

# HelloWorld.ps1
param (
  [string]$TestMSBuildString,
  [string]$TestString,
  [string]$TestBoolean,
  [string]$TestNumber,
  # MSBuild.PowerShell provides $ScriptFolderPath to scripts as $PSScriptRoot is not available
  [string]$ScriptFolderPath # You can use this to import modules or other scripts
)

# Load the TestHelper.ps1 module via a relative path
Import-Module "$ScriptFolderPath\modules\TestHelper.ps1"

# Call the TestHelper.ps1 Log function to Write-Information (demonstration purposes)
Log "HelloWorld.ps1 - Hello World from PowerShell!"
Log "HelloWorld.ps1 - TestMSBuildString: $TestMSBuildString"
Log "HelloWorld.ps1 - TestString: $TestString"
Log "HelloWorld.ps1 - TestBoolean: $TestBoolean"
Log "HelloWorld.ps1 - TestNumber: $TestNumber"

Local PowerShell Helper Example

# /modules/TestHelper.ps1
function Log {
  param (
    [string]$message
  )
  Write-Information $message
}

Run Locally or Remotely

Parameters vary between <RemotePowerShellTask>, <PowerShellTask> and <LocalPowerShellTask>:

• Remote operations need the parameter ComputerName to use PSRemoting for running on the chosen machine.
• Standard (not local or remote) needs RunRemotely and ComputerName. As it can be either local/remote.
• Local operations don't need to specify any additional parameters.

TIP: RunRemotely is useful if you need to do a local or remote operation, based on a MSBuild property. <br><br> For example, you have a local and remote publish profile, and you want to use the same target for both. <br><br> You can set <RunRemotely> in each profile, and the task will run locally or remotely based on the profile.