Adding errors to build summary from PowerShell script running in VSTS

Question

In VSTS, I am using a PowerShell task to run one of my script. The script contains the following:

Write-Error 'error 1'
Write-Error 'error 2'

Since the Write-Error cmdlet writes on stderr, these messages get reported in the VSTS web interface:

I would like to improve on this output. The improvements that I am looking for is:

I would like to have one red X per error.
I would like to remove all the noise, i.e. get rid of the lines starting with '+'

Instead of calling Write-Error, is there another function that I can call from my script to add an error to the build summary page?

I saw the function Write-VstsTaskError but unfortunately it can only be called from a VSTS task. It cannot be called from my script.

Matt Brooks · Accepted Answer · 2016-04-04 14:23:14Z

9

The recommended way to do this is using VSO logging commands as discussed in the GitHub issue below.

For example:

Write-Host "##vso[task.logissue type=warning;]Test warning"
Write-Host "##vso[task.logissue type=error;]Test error"

edited Apr 4, 2016 at 14:23

answered Apr 3, 2016 at 12:28

Matt Brooks

1,6041 gold badge15 silver badges27 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

mabead Over a year ago

It is important to note that adding errors through logging commands does not mark the build step as failed. One must therefore throw an exception (or log on stderr) when it logged at least one error through logging commands.

Matt Brooks Over a year ago

Good point regarding failing the build step. I've corrected a typo in the first URL now.

lstanczyk Over a year ago

That is what i need, but using TFS 2013. Is there any way to achieve it with 2013?

mabead · Accepted Answer · 2016-02-10 20:06:57Z

1

After lots of trial and error, I was able to solve problem #1. The VSTS build displays a red X for each entry in stderr that is seperated by an entry on stdout. So, if I change my script to the following:

Write-Error 'Error 1'
Write-Host '***'
Write-Error 'Error 2'
Write-Host '***'

I now have one red X per error, but I still have the extra noise (lines starting with '+').

answered Feb 10, 2016 at 20:06

mabead

2,4014 gold badges31 silver badges45 bronze badges

Comments

Rogerson Nazário · Accepted Answer · 2017-08-31 19:08:31Z

0

In a build with Visual Studio 2013, I have tested with these two approaches and worked:

[Console]::Error.WriteLine("An error occurred.")

$host.ui.WriteErrorLine("Other way to show an error.")

Hope that helps.

answered Aug 31, 2017 at 19:08

Rogerson Nazário

3425 silver badges16 bronze badges

Collectives™ on Stack Overflow

Adding errors to build summary from PowerShell script running in VSTS

3 Answers 3

3 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related