Add support for file commands GITHUB_OUTPUT and GITHUB_STATE

hugoalh · hugoalh · commit 8ae52d28e9ca · 2022-09-30T12:50:33.000+08:00
diff --git a/hugoalh.GitHubActionsToolkit/module/command-base.psm1 b/hugoalh.GitHubActionsToolkit/module/command-base.psm1
@@ -1,5 +1,12 @@
 #Requires -PSEdition Core
 #Requires -Version 7.2
+Import-Module -Name (
+	@(
+		'internal\token.psm1'
+	) |
+		ForEach-Object -Process { Join-Path -Path $PSScriptRoot -ChildPath $_ }
+) -Prefix 'GitHubActions' -Scope 'Local'
+[String[]]$GitHubActionsFileCommandTokensUsed = @()
 <#
 .SYNOPSIS
 GitHub Actions (Private) - Format Command Parameter Value
@@ -76,6 +83,46 @@ Function Write-Command {
 		)" : '')::$(Format-CommandValue -InputObject $Value)"
 	}
 }
+<#
+.SYNOPSIS
+GitHub Actions (Private) - Write File Command
+.DESCRIPTION
+Write file command to communicate with the runner machine.
+.PARAMETER LiteralPath
+Literal path of the file.
+.PARAMETER Table
+Table.
+.OUTPUTS
+[Void]
+#>
+Function Write-FileCommand {
+	[CmdletBinding()]
+	[OutputType([Void])]
+	Param (
+		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][String]$LiteralPath,
+		[Parameter(Mandatory = $True, Position = 1, ValueFromPipelineByPropertyName = $True)][Hashtable]$Table
+	)
+	Process {
+		Add-Content -LiteralPath $LiteralPath -Value (
+			$Table.GetEnumerator() |
+				ForEach-Object -Process {
+					If ($_.Value -imatch '^.+$') {
+						Write-Output -InputObject "$($_.Name)=$($_.Value)"
+					}
+					Else {
+						Do {
+							[String]$Token = New-GitHubActionsRandomToken -Length 64
+						}
+						While ( $Token -iin $GitHubActionsFileCommandTokensUsed )
+						$Script:GitHubActionsFileCommandTokensUsed += $Token
+						Write-Output -InputObject "$($_.Name)=<<$Token`n$($_.Value -ireplace '\r?\n', "`n")`n$Token"
+					}
+				} |
+				Join-String -Separator "`n"
+		) -Confirm:$False -Encoding 'UTF8NoBOM'
+	}
+}
 Export-ModuleMember -Function @(
-	'Write-Command'
+	'Write-Command',
+	'Write-FileCommand'
 )
diff --git a/hugoalh.GitHubActionsToolkit/module/environment-variable.psm1 b/hugoalh.GitHubActionsToolkit/module/environment-variable.psm1
@@ -148,11 +148,7 @@ Function Set-EnvironmentVariable {
 							ForEach-Object -Process { Write-GitHubActionsCommand -Command 'set-env' -Parameter @{ 'name' = $_.Name } -Value $_.Value }
 					}
 					Else {
-						Add-Content -LiteralPath $Env:GITHUB_ENV -Value (
-							$Result.GetEnumerator() |
-								ForEach-Object -Process { "$($_.Name)=$($_.Value)" } |
-								Join-String -Separator "`n"
-						) -Confirm:$False -Encoding 'UTF8NoBOM'
+						Write-GitHubActionsFileCommand -LiteralPath $Env:GITHUB_ENV -Table $Result
 					}
 				}
 			}
diff --git a/hugoalh.GitHubActionsToolkit/module/parameter.psm1 b/hugoalh.GitHubActionsToolkit/module/parameter.psm1
@@ -174,6 +174,10 @@ Function Set-Output {
 		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipelineByPropertyName = $True)][ValidatePattern('^(?:[\da-z][\da-z_-]*)?[\da-z]$', ErrorMessage = '`{0}` is not a valid GitHub Actions output name!')][Alias('Key')][String]$Name,
 		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 1, ValueFromPipelineByPropertyName = $True)][AllowEmptyString()][String]$Value
 	)
+	Begin {
+		[Boolean]$FileEditionAvailable = ![String]::IsNullOrWhiteSpace($Env:GITHUB_OUTPUT)
+		[Hashtable]$Result = @{}
+	}
 	Process {
 		Switch ($PSCmdlet.ParameterSetName) {
 			'Multiple' {
@@ -191,14 +195,29 @@ Function Set-Output {
 							Write-Error -Message 'Parameter `Value` must be type of string!' -Category 'InvalidType'
 							Return
 						}
-						Write-GitHubActionsCommand -Command 'set-output' -Parameter @{ 'name' = $_.Name } -Value $_.Value
+						If ($FileEditionAvailable) {
+							$Result[$_.Name] = $_.Value
+						}
+						Else {
+							Write-GitHubActionsCommand -Command 'set-output' -Parameter @{ 'name' = $_.Name } -Value $_.Value
+						}
 					}
 			}
 			'Single' {
-				Write-GitHubActionsCommand -Command 'set-output' -Parameter @{ 'name' = $Name } -Value $Value
+				If ($FileEditionAvailable) {
+					$Result[$Name] = $Value
+				}
+				Else {
+					Write-GitHubActionsCommand -Command 'set-output' -Parameter @{ 'name' = $Name } -Value $Value
+				}
 			}
 		}
 	}
+	End {
+		If ($FileEditionAvailable) {
+			Write-GitHubActionsFileCommand -LiteralPath $Env:GITHUB_OUTPUT -Table $Result
+		}
+	}
 }
 <#
 .SYNOPSIS
@@ -222,6 +241,10 @@ Function Set-State {
 		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipelineByPropertyName = $True)][ValidatePattern('^(?:[\da-z][\da-z_-]*)?[\da-z]$', ErrorMessage = '`{0}` is not a valid GitHub Actions state name!')][Alias('Key')][String]$Name,
 		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 1, ValueFromPipelineByPropertyName = $True)][AllowEmptyString()][String]$Value
 	)
+	Begin {
+		[Boolean]$FileEditionAvailable = ![String]::IsNullOrWhiteSpace($Env:GITHUB_STATE)
+		[Hashtable]$Result = @{}
+	}
 	Process {
 		Switch ($PSCmdlet.ParameterSetName) {
 			'Multiple' {
@@ -239,14 +262,29 @@ Function Set-State {
 							Write-Error -Message 'Parameter `Value` must be type of string!' -Category 'InvalidType'
 							Return
 						}
-						Write-GitHubActionsCommand -Command 'save-state' -Parameter @{ 'name' = $_.Name } -Value $_.Value
+						If ($FileEditionAvailable) {
+							$Result[$_.Name] = $_.Value
+						}
+						Else {
+							Write-GitHubActionsCommand -Command 'save-state' -Parameter @{ 'name' = $_.Name } -Value $_.Value
+						}
 					}
 			}
 			'Single' {
-				Write-GitHubActionsCommand -Command 'save-state' -Parameter @{ 'name' = $Name } -Value $Value
+				If ($FileEditionAvailable) {
+					$Result[$Name] = $Value
+				}
+				Else {
+					Write-GitHubActionsCommand -Command 'save-state' -Parameter @{ 'name' = $Name } -Value $Value
+				}
 			}
 		}
 	}
+	End {
+		If ($FileEditionAvailable) {
+			Write-GitHubActionsFileCommand -LiteralPath $Env:GITHUB_STATE -Table $Result
+		}
+	}
 }
 Set-Alias -Name 'Save-State' -Value 'Set-State' -Option 'ReadOnly' -Scope 'Local'
 Export-ModuleMember -Function @(

Original file line number	Diff line number	Diff line change
`@@ -148,11 +148,7 @@ Function Set-EnvironmentVariable {`
`148`	`148`	`ForEach-Object -Process { Write-GitHubActionsCommand -Command 'set-env' -Parameter @{ 'name' = $_.Name } -Value $_.Value }`
`149`	`149`	`}`
`150`	`150`	`Else {`
`151`		`- Add-Content -LiteralPath $Env:GITHUB_ENV -Value (`
`152`		`- $Result.GetEnumerator() \|`
`153`		`- ForEach-Object -Process { "$($_.Name)=$($_.Value)" } \|`
`154`		- Join-String -Separator "`n"
`155`		`- ) -Confirm:$False -Encoding 'UTF8NoBOM'`
	`151`	`+ Write-GitHubActionsFileCommand -LiteralPath $Env:GITHUB_ENV -Table $Result`
`156`	`152`	`}`
`157`	`153`	`}`
`158`	`154`	`}`
Original file line number	Diff line number	Diff line change
`@@ -174,6 +174,10 @@ Function Set-Output {`
`174`	`174`	[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipelineByPropertyName = $True)][ValidatePattern('^(?:[\da-z][\da-z_-]*)?[\da-z]$', ErrorMessage = '`{0}` is not a valid GitHub Actions output name!')][Alias('Key')][String]$Name,
`175`	`175`	`[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 1, ValueFromPipelineByPropertyName = $True)][AllowEmptyString()][String]$Value`
`176`	`176`	`)`
	`177`	`+ Begin {`
	`178`	`+ [Boolean]$FileEditionAvailable = ![String]::IsNullOrWhiteSpace($Env:GITHUB_OUTPUT)`
	`179`	`+ [Hashtable]$Result = @{}`
	`180`	`+ }`
`177`	`181`	`Process {`
`178`	`182`	`Switch ($PSCmdlet.ParameterSetName) {`
`179`	`183`	`'Multiple' {`
`@@ -191,14 +195,29 @@ Function Set-Output {`
`191`	`195`	Write-Error -Message 'Parameter `Value` must be type of string!' -Category 'InvalidType'
`192`	`196`	`Return`
`193`	`197`	`}`
`194`		`- Write-GitHubActionsCommand -Command 'set-output' -Parameter @{ 'name' = $_.Name } -Value $_.Value`
	`198`	`+ If ($FileEditionAvailable) {`
	`199`	`+ $Result[$_.Name] = $_.Value`
	`200`	`+ }`
	`201`	`+ Else {`
	`202`	`+ Write-GitHubActionsCommand -Command 'set-output' -Parameter @{ 'name' = $_.Name } -Value $_.Value`
	`203`	`+ }`
`195`	`204`	`}`
`196`	`205`	`}`
`197`	`206`	`'Single' {`
`198`		`- Write-GitHubActionsCommand -Command 'set-output' -Parameter @{ 'name' = $Name } -Value $Value`
	`207`	`+ If ($FileEditionAvailable) {`
	`208`	`+ $Result[$Name] = $Value`
	`209`	`+ }`
	`210`	`+ Else {`
	`211`	`+ Write-GitHubActionsCommand -Command 'set-output' -Parameter @{ 'name' = $Name } -Value $Value`
	`212`	`+ }`
`199`	`213`	`}`
`200`	`214`	`}`
`201`	`215`	`}`
	`216`	`+ End {`
	`217`	`+ If ($FileEditionAvailable) {`
	`218`	`+ Write-GitHubActionsFileCommand -LiteralPath $Env:GITHUB_OUTPUT -Table $Result`
	`219`	`+ }`
	`220`	`+ }`
`202`	`221`	`}`
`203`	`222`	`<#`
`204`	`223`	`.SYNOPSIS`
`@@ -222,6 +241,10 @@ Function Set-State {`
`222`	`241`	[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipelineByPropertyName = $True)][ValidatePattern('^(?:[\da-z][\da-z_-]*)?[\da-z]$', ErrorMessage = '`{0}` is not a valid GitHub Actions state name!')][Alias('Key')][String]$Name,
`223`	`242`	`[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 1, ValueFromPipelineByPropertyName = $True)][AllowEmptyString()][String]$Value`
`224`	`243`	`)`
	`244`	`+ Begin {`
	`245`	`+ [Boolean]$FileEditionAvailable = ![String]::IsNullOrWhiteSpace($Env:GITHUB_STATE)`
	`246`	`+ [Hashtable]$Result = @{}`
	`247`	`+ }`
`225`	`248`	`Process {`
`226`	`249`	`Switch ($PSCmdlet.ParameterSetName) {`
`227`	`250`	`'Multiple' {`
`@@ -239,14 +262,29 @@ Function Set-State {`
`239`	`262`	Write-Error -Message 'Parameter `Value` must be type of string!' -Category 'InvalidType'
`240`	`263`	`Return`
`241`	`264`	`}`
`242`		`- Write-GitHubActionsCommand -Command 'save-state' -Parameter @{ 'name' = $_.Name } -Value $_.Value`
	`265`	`+ If ($FileEditionAvailable) {`
	`266`	`+ $Result[$_.Name] = $_.Value`
	`267`	`+ }`
	`268`	`+ Else {`
	`269`	`+ Write-GitHubActionsCommand -Command 'save-state' -Parameter @{ 'name' = $_.Name } -Value $_.Value`
	`270`	`+ }`
`243`	`271`	`}`
`244`	`272`	`}`
`245`	`273`	`'Single' {`
`246`		`- Write-GitHubActionsCommand -Command 'save-state' -Parameter @{ 'name' = $Name } -Value $Value`
	`274`	`+ If ($FileEditionAvailable) {`
	`275`	`+ $Result[$Name] = $Value`
	`276`	`+ }`
	`277`	`+ Else {`
	`278`	`+ Write-GitHubActionsCommand -Command 'save-state' -Parameter @{ 'name' = $Name } -Value $Value`
	`279`	`+ }`
`247`	`280`	`}`
`248`	`281`	`}`
`249`	`282`	`}`
	`283`	`+ End {`
	`284`	`+ If ($FileEditionAvailable) {`
	`285`	`+ Write-GitHubActionsFileCommand -LiteralPath $Env:GITHUB_STATE -Table $Result`
	`286`	`+ }`
	`287`	`+ }`
`250`	`288`	`}`
`251`	`289`	`Set-Alias -Name 'Save-State' -Value 'Set-State' -Option 'ReadOnly' -Scope 'Local'`
`252`	`290`	`Export-ModuleMember -Function @(`