Skip to content

Commit 6af18ba

Browse files
KevinRansomKevinRansom
authored
Merge pull request #10644 from dotnet/merges/main-to-feature/nullness
Merge main to feature/nullness
2 parents f6f7792 + 10104cc commit 6af18ba

File tree

6 files changed

+112
-52
lines changed

6 files changed

+112
-52
lines changed

‎eng/Version.Details.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<ProductDependencies>
44
</ProductDependencies>
55
<ToolsetDependencies>
6-
<Dependency Name="Microsoft.DotNet.Arcade.Sdk" Version="6.0.0-beta.20601.2">
6+
<Dependency Name="Microsoft.DotNet.Arcade.Sdk" Version="6.0.0-beta.20604.2">
77
<Uri>https://github.com/dotnet/arcade</Uri>
8-
<Sha>6d8efa00a7dd2d15e07df673a83cecb8a0a3031f</Sha>
8+
<Sha>ea609b8e036359934332480de9336d98fcbb3f91</Sha>
99
</Dependency>
1010
</ToolsetDependencies>
1111
</Dependencies>

‎eng/common/pipeline-logging-functions.ps1‎

Lines changed: 61 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ function Write-PipelineTelemetryError {
2929
[switch]$AsOutput,
3030
[switch]$Force)
3131

32-
$PSBoundParameters.Remove('Category') | Out-Null
32+
$PSBoundParameters.Remove('Category') | Out-Null
3333

34-
if($Force -Or ((Test-Path variable:ci) -And $ci)) {
35-
$Message = "(NETCORE_ENGINEERING_TELEMETRY=$Category) $Message"
36-
}
37-
$PSBoundParameters.Remove('Message') | Out-Null
38-
$PSBoundParameters.Add('Message', $Message)
39-
Write-PipelineTaskError @PSBoundParameters
34+
if ($Force -Or ((Test-Path variable:ci) -And $ci)) {
35+
$Message = "(NETCORE_ENGINEERING_TELEMETRY=$Category) $Message"
36+
}
37+
$PSBoundParameters.Remove('Message') | Out-Null
38+
$PSBoundParameters.Add('Message', $Message)
39+
Write-PipelineTaskError @PSBoundParameters
4040
}
4141

4242
# Specify "-Force" to force pipeline formatted output even if "$ci" is false or not set
@@ -55,8 +55,8 @@ function Write-PipelineTaskError {
5555
[switch]$Force
5656
)
5757

58-
if(!$Force -And (-Not (Test-Path variable:ci) -Or !$ci)) {
59-
if($Type -eq 'error') {
58+
if (!$Force -And (-Not (Test-Path variable:ci) -Or !$ci)) {
59+
if ($Type -eq 'error') {
6060
Write-Host $Message -ForegroundColor Red
6161
return
6262
}
@@ -66,47 +66,61 @@ function Write-PipelineTaskError {
6666
}
6767
}
6868

69-
if(($Type -ne 'error') -and ($Type -ne 'warning')) {
69+
if (($Type -ne 'error') -and ($Type -ne 'warning')) {
7070
Write-Host $Message
7171
return
7272
}
7373
$PSBoundParameters.Remove('Force') | Out-Null
74-
if(-not $PSBoundParameters.ContainsKey('Type')) {
74+
if (-not $PSBoundParameters.ContainsKey('Type')) {
7575
$PSBoundParameters.Add('Type', 'error')
7676
}
7777
Write-LogIssue @PSBoundParameters
78-
}
78+
}
7979

80-
function Write-PipelineSetVariable {
80+
function Write-PipelineSetVariable {
8181
[CmdletBinding()]
8282
param(
83-
[Parameter(Mandatory = $true)]
84-
[string]$Name,
85-
[string]$Value,
86-
[switch]$Secret,
87-
[switch]$AsOutput,
88-
[bool]$IsMultiJobVariable=$true)
89-
90-
if((Test-Path variable:ci) -And $ci) {
83+
[Parameter(Mandatory = $true)]
84+
[string]$Name,
85+
[string]$Value,
86+
[switch]$Secret,
87+
[switch]$AsOutput,
88+
[bool]$IsMultiJobVariable = $true)
89+
90+
if ((Test-Path variable:ci) -And $ci) {
9191
Write-LoggingCommand -Area 'task' -Event 'setvariable' -Data $Value -Properties @{
92-
'variable' = $Name
93-
'isSecret' = $Secret
94-
'isOutput' = $IsMultiJobVariable
92+
'variable' = $Name
93+
'isSecret' = $Secret
94+
'isOutput' = $IsMultiJobVariable
9595
} -AsOutput:$AsOutput
96-
}
97-
}
96+
}
97+
}
9898

99-
function Write-PipelinePrependPath {
99+
function Write-PipelinePrependPath {
100100
[CmdletBinding()]
101101
param(
102-
[Parameter(Mandatory=$true)]
103-
[string]$Path,
104-
[switch]$AsOutput)
102+
[Parameter(Mandatory = $true)]
103+
[string]$Path,
104+
[switch]$AsOutput)
105105

106-
if((Test-Path variable:ci) -And $ci) {
106+
if ((Test-Path variable:ci) -And $ci) {
107107
Write-LoggingCommand -Area 'task' -Event 'prependpath' -Data $Path -AsOutput:$AsOutput
108-
}
109-
}
108+
}
109+
}
110+
111+
function Write-PipelineSetResult {
112+
[CmdletBinding()]
113+
param(
114+
[ValidateSet("Succeeded", "SucceededWithIssues", "Failed", "Cancelled", "Skipped")]
115+
[Parameter(Mandatory = $true)]
116+
[string]$Result,
117+
[string]$Message)
118+
if ((Test-Path variable:ci) -And $ci) {
119+
Write-LoggingCommand -Area 'task' -Event 'complete' -Data $Message -Properties @{
120+
'result' = $Result
121+
}
122+
}
123+
}
110124

111125
<########################################
112126
# Private functions.
@@ -123,7 +137,8 @@ function Format-LoggingCommandData {
123137
foreach ($mapping in $script:loggingCommandEscapeMappings) {
124138
$Value = $Value.Replace($mapping.Token, $mapping.Replacement)
125139
}
126-
} else {
140+
}
141+
else {
127142
for ($i = $script:loggingCommandEscapeMappings.Length - 1 ; $i -ge 0 ; $i--) {
128143
$mapping = $script:loggingCommandEscapeMappings[$i]
129144
$Value = $Value.Replace($mapping.Replacement, $mapping.Token)
@@ -156,7 +171,8 @@ function Format-LoggingCommand {
156171
if ($first) {
157172
$null = $sb.Append(' ')
158173
$first = $false
159-
} else {
174+
}
175+
else {
160176
$null = $sb.Append(';')
161177
}
162178

@@ -193,7 +209,8 @@ function Write-LoggingCommand {
193209
$command = Format-LoggingCommand -Area $Area -Event $Event -Data $Data -Properties $Properties
194210
if ($AsOutput) {
195211
$command
196-
} else {
212+
}
213+
else {
197214
Write-Host $command
198215
}
199216
}
@@ -212,12 +229,12 @@ function Write-LogIssue {
212229
[switch]$AsOutput)
213230

214231
$command = Format-LoggingCommand -Area 'task' -Event 'logissue' -Data $Message -Properties @{
215-
'type' = $Type
216-
'code' = $ErrCode
217-
'sourcepath' = $SourcePath
218-
'linenumber' = $LineNumber
219-
'columnnumber' = $ColumnNumber
220-
}
232+
'type' = $Type
233+
'code' = $ErrCode
234+
'sourcepath' = $SourcePath
235+
'linenumber' = $LineNumber
236+
'columnnumber' = $ColumnNumber
237+
}
221238
if ($AsOutput) {
222239
return $command
223240
}
@@ -229,7 +246,8 @@ function Write-LogIssue {
229246
$foregroundColor = [System.ConsoleColor]::Red
230247
$backgroundColor = [System.ConsoleColor]::Black
231248
}
232-
} else {
249+
}
250+
else {
233251
$foregroundColor = $host.PrivateData.WarningForegroundColor
234252
$backgroundColor = $host.PrivateData.WarningBackgroundColor
235253
if ($foregroundColor -isnot [System.ConsoleColor] -or $backgroundColor -isnot [System.ConsoleColor]) {

‎eng/common/pipeline-logging-functions.sh‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,4 +179,28 @@ function Write-PipelinePrependPath {
179179
if [[ "$ci" == true ]]; then
180180
echo "##vso[task.prependpath]$prepend_path"
181181
fi
182-
}
182+
}
183+
184+
function Write-PipelineSetResult {
185+
local result=''
186+
local message=''
187+
188+
while [[ $# -gt 0 ]]; do
189+
opt="$(echo "${1/#--/-}" | awk '{print tolower($0)}')"
190+
case "$opt" in
191+
-result|-r)
192+
result=$2
193+
shift
194+
;;
195+
-message|-m)
196+
message=$2
197+
shift
198+
;;
199+
esac
200+
shift
201+
done
202+
203+
if [[ "$ci" == true ]]; then
204+
echo "##vso[task.complete result=$result;]$message"
205+
fi
206+
}

‎eng/common/tools.ps1‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -677,14 +677,23 @@ function MSBuild-Core() {
677677
$exitCode = Exec-Process $buildTool.Path $cmdArgs
678678

679679
if ($exitCode -ne 0) {
680-
Write-PipelineTelemetryError -Category 'Build' -Message 'Build failed.'
680+
# We should not Write-PipelineTaskError here because that message shows up in the build summary
681+
# The build already logged an error, that's the reason it failed. Producing an error here only adds noise.
682+
Write-Host "Build failed with exit code $exitCode. Check errors above." -ForegroundColor Red
681683

682684
$buildLog = GetMSBuildBinaryLogCommandLineArgument $args
683-
if ($buildLog -ne $null) {
685+
if ($null -ne $buildLog) {
684686
Write-Host "See log: $buildLog" -ForegroundColor DarkGray
685687
}
686688

687-
ExitWithExitCode $exitCode
689+
if ($ci) {
690+
Write-PipelineSetResult -Result "Failed" -Message "msbuild execution failed."
691+
# Exiting with an exit code causes the azure pipelines task to log yet another "noise" error
692+
# The above Write-PipelineSetResult will cause the task to be marked as failure without adding yet another error
693+
ExitWithExitCode 0
694+
} else {
695+
ExitWithExitCode $exitCode
696+
}
688697
}
689698
}
690699

‎eng/common/tools.sh‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -441,8 +441,17 @@ function MSBuild-Core {
441441

442442
"$_InitializeBuildTool" "$@" || {
443443
local exit_code=$?
444-
Write-PipelineTaskError "Build failed (exit code '$exit_code')."
445-
ExitWithExitCode $exit_code
444+
# We should not Write-PipelineTaskError here because that message shows up in the build summary
445+
# The build already logged an error, that's the reason it failed. Producing an error here only adds noise.
446+
echo "Build failed with exit code $exit_code. Check errors above."
447+
if [[ "$ci" == "true" ]]; then
448+
Write-PipelineSetResult -result "Failed" -message "msbuild execution failed."
449+
# Exiting with an exit code causes the azure pipelines task to log yet another "noise" error
450+
# The above Write-PipelineSetResult will cause the task to be marked as failure without adding yet another error
451+
ExitWithExitCode 0
452+
else
453+
ExitWithExitCode $exit_code
454+
fi
446455
}
447456
}
448457

‎global.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
}
1414
},
1515
"msbuild-sdks": {
16-
"Microsoft.DotNet.Arcade.Sdk": "6.0.0-beta.20601.2",
16+
"Microsoft.DotNet.Arcade.Sdk": "6.0.0-beta.20604.2",
1717
"Microsoft.DotNet.Helix.Sdk": "2.0.0-beta.19069.2"
1818
}
1919
}

0 commit comments

Comments
 (0)