VSTS | TFS 2018 | TFS 2017 | TFS 2015
Run a PowerShell script
|Script filename||Specify the path to the script to you want to run. The path must be a fully qualified path or a valid path relative to the default working directory. In Team Foundation Build, this directory is $(Build.SourcesDirectory).|
|Arguments||Specify arguments to pass to the script. You can use ordinal or named parameters.|
|Advanced - Working folder||Specify the working directory in which you want to run the script. If you leave it empty, the working directory is the folder where the script is located.|
test.ps1 at the root of your repo:
Write-Host "Hello World from $Env:AGENT_NAME." Write-Host "My ID is $Env:AGENT_ID." Write-Host "AGENT_WORKFOLDER contents:" gci $Env:AGENT_WORKFOLDER Write-Host "AGENT_BUILDDIRECTORY contents:" gci $Env:AGENT_BUILDDIRECTORY Write-Host "BUILD_SOURCESDIRECTORY contents:" gci $Env:BUILD_SOURCESDIRECTORY Write-Host "Over and out."
On the Build tab of a build definition, add this step:
Write a warning
Set warning message
"You've been warned by"
Write-Host "$("##vso[task.setvariable variable=WarningMessage]") $($args)"
Write warning using task.LogIssue
# Writes a warning to build summary and to log in yellow text Write-Host "$("##vso[task.logissue type=warning;]") $($env:WarningMessage) $("the task.LogIssue Team Build logging command.")"
Write warning using PowerShell command
# Writes a warning to log preceded by "WARNING: " Write-Warning "$($env:WarningMessage) $("the Write-Warning PowerShell command.")"
Write an error
Set error message
"something went wrong."
Write-Host "$("##vso[task.setvariable variable=ErrorMessage]") $($args)"
Write error using task.LogIssue
# Writes an error to the build summary and to the log in red text Write-Host "$("##vso[task.logissue type=error;]") $("the task.LogIssue Team Build logging command reported that") $($env:ErrorMessage)"
If you want this error to fail the build, then add this line:
Write error using PowerShell command
# Writes an error to the build summary and the log with details about the error Write-Error "$("the Write-Error PowerShell command reported that") $($env:ErrorMessage)"
If you don't want this error to fail the build, then clear the Advanced: Fail on Standard Error check box.
Where can I learn about PowerShell scripts?
How do I set a variable so that it can be read by subsequent scripts and tasks?
Q: I'm having problems. How can I troubleshoot them?
A: Try this:
On the variables tab, add
system.debugand set it to
true. Select to allow at queue time.
In the explorer tab, view your completed build and click the build step to view its output.
The control options arguments described above can also be useful when you're trying to isolate a problem.
Q: How do variables work? What variables are available for me to use in the arguments?
$(Agent.BuildDirectory) are just a few of the variables you can use. See Variables.
Do I need an agent?
You need at least one agent to run your build or release. Get an agent.