Skip to content

Commit 9e62d90

Browse files
committed
Fix some linter warnings in install_windows.ps1
(For PSScriptAnalyzer) * Bypasses warnings for unused apt_source and yum_source parameters which are part of the overall install task parameters for the linux side of the house. * Switches to named parameters for the Write-Result function calls as requested by the linter
1 parent 7198adb commit 9e62d90

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

tasks/install_windows.ps1

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'apt_source', Justification='Used by Bolt task wrapper for Linux installs')]
2+
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'yum_source', Justification='Used by Bolt task wrapper for Linux installs')]
3+
14
[CmdletBinding()]
25
param(
36
[Parameter(Mandatory = $false)]
@@ -34,7 +37,7 @@ function Write-Result($status, $message, $extra = @{}) {
3437

3538
# Exit if anything other than the agent is requested
3639
if ($package -ne $agent_package) {
37-
Write-Result "failure" "Unsupported package name '$package'. This task only supports '$agent_package'."
40+
Write-Result -status "failure" -message "Unsupported package name '$package'. This task only supports '$agent_package'."
3841
}
3942

4043
try {
@@ -46,7 +49,7 @@ try {
4649
if ($installed) {
4750
$installedVersion = $installed.DisplayVersion
4851
if ($installedVersion -eq $version) {
49-
Write-Result "skipped" "$agent_package $version is already installed." @{ version = $installedVersion }
52+
Write-Result -status "skipped" -message "$agent_package $version is already installed." @{ version = $installedVersion }
5053
}
5154
}
5255

@@ -60,7 +63,7 @@ try {
6063
Write-Verbose "Stopping $serviceName service as requested."
6164
Stop-Service -Name $serviceName -Force -ErrorAction Stop
6265
} else {
63-
Write-Result "failure" "The $serviceName service is running. Use stop_service=true to allow upgrade."
66+
Write-Result -status "failure" -message "The $serviceName service is running. Use stop_service=true to allow upgrade."
6467
}
6568
}
6669
}
@@ -95,12 +98,12 @@ try {
9598
}
9699

97100
# Return success result
98-
Write-Result "success" "$agent_package $version installed successfully." @{
101+
Write-Result -status "success" -message "$agent_package $version installed successfully." @{
99102
package = $agent_package
100103
version = $newInstall.DisplayVersion
101104
source = $url
102105
}
103106

104107
} catch {
105-
Write-Result "failure" $_.Exception.Message
108+
Write-Result -status "failure" -message $_.Exception.Message
106109
}

0 commit comments

Comments
 (0)