20221016C

Author: hugoalh

README.md

@@ -61,6 +61,7 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
 - `Add-GitHubActionsStepSummaryLink`
 - `Add-GitHubActionsStepSummarySubscriptText`
 - `Add-GitHubActionsStepSummarySuperscriptText`
+- `Clear-GitHubActionsFileCommand`
 - `Disable-GitHubActionsEchoingCommands`
 - `Disable-GitHubActionsProcessingCommands`
 - `Enable-GitHubActionsEchoingCommands`
@@ -81,7 +82,6 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scop
 - `Invoke-GitHubActionsToolCacheToolDownloader` 🔘
 - `Register-GitHubActionsToolCacheDirectory` 🔘
 - `Register-GitHubActionsToolCacheFile` 🔘
-- `Remove-GitHubActionsFileCommand`
 - `Remove-GitHubActionsProblemMatcher`
 - `Remove-GitHubActionsStepSummary`
 - `Restore-GitHubActionsCache` 🔘

hugoalh.GitHubActionsToolkit/hugoalh.GitHubActionsToolkit.psd1

@@ -70,6 +70,7 @@
 		'Add-StepSummaryLink',
 		'Add-StepSummarySubscriptText',
 		'Add-StepSummarySuperscriptText',
+		'Clear-FileCommand',
 		'Disable-EchoingCommands',
 		'Disable-ProcessingCommands',
 		'Enable-EchoingCommands',
@@ -90,7 +91,6 @@
 		'Invoke-ToolCacheToolDownloader',
 		'Register-ToolCacheDirectory',
 		'Register-ToolCacheFile',
-		'Remove-FileCommand',
 		'Remove-ProblemMatcher',
 		'Remove-StepSummary',
 		'Restore-Cache',
@@ -243,7 +243,7 @@
 			ReleaseNotes = '(Please visit https://github.com/hugoalh-studio/ghactions-toolkit-powershell/releases.)'
 
 			# Prerelease string of this module
-			Prerelease = 'beta3'
+			Prerelease = 'beta4'
 
 			# Flag to indicate whether the module requires explicit user acceptance for install/update/save
 			RequireLicenseAcceptance = $False

hugoalh.GitHubActionsToolkit/module/command-base.psm1

@@ -15,6 +15,38 @@ Import-Module -Name (
 }
 <#
 .SYNOPSIS
+GitHub Actions - Clear File Command
+.DESCRIPTION
+Clear the file commands.
+.PARAMETER Type
+Types of the file commands.
+.OUTPUTS
+[Void]
+#>
+Function Clear-FileCommand {
+	[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_clear-githubactionsfilecommand#Clear-GitHubActionsFileCommand')]
+	[OutputType([Void])]
+	Param (
+		[Parameter(Mandatory = $True, Position = 0)][Alias('Types')][GitHubActionsFileCommandTypes]$Type
+	)
+	If (($Type -band [GitHubActionsFileCommandTypes]::EnvironmentVariable) -ieq [GitHubActionsFileCommandTypes]::EnvironmentVariable) {
+		Remove-Item -LiteralPath $Env:GITHUB_ENV -Confirm:$False -ErrorAction 'Continue'
+	}
+	If (($Type -band [GitHubActionsFileCommandTypes]::Output) -ieq [GitHubActionsFileCommandTypes]::Output) {
+		Remove-Item -LiteralPath $Env:GITHUB_OUTPUT -Confirm:$False -ErrorAction 'Continue'
+	}
+	If (($Type -band [GitHubActionsFileCommandTypes]::Path) -ieq [GitHubActionsFileCommandTypes]::Path) {
+		Remove-Item -LiteralPath $Env:GITHUB_PATH -Confirm:$False -ErrorAction 'Continue'
+	}
+	If (($Type -band [GitHubActionsFileCommandTypes]::State) -ieq [GitHubActionsFileCommandTypes]::State) {
+		Remove-Item -LiteralPath $Env:GITHUB_STATE -Confirm:$False -ErrorAction 'Continue'
+	}
+	If (($Type -band [GitHubActionsFileCommandTypes]::StepSummary) -ieq [GitHubActionsFileCommandTypes]::StepSummary) {
+		Remove-Item -LiteralPath $Env:GITHUB_STEP_SUMMARY -Confirm:$False -ErrorAction 'Continue'
+	}
+}
+<#
+.SYNOPSIS
 GitHub Actions (Private) - Format Command Parameter Value
 .DESCRIPTION
 Format the command parameter value characters that can cause issues.
@@ -60,38 +92,6 @@ Set-Alias -Name 'Format-CommandContent' -Value 'Format-CommandValue' -Option 'Re
 Set-Alias -Name 'Format-CommandMessage' -Value 'Format-CommandValue' -Option 'ReadOnly' -Scope 'Local'
 <#
 .SYNOPSIS
-GitHub Actions - Remove File Command
-.DESCRIPTION
-Remove the file commands.
-.PARAMETER Type
-Types of the file commands.
-.OUTPUTS
-[Void]
-#>
-Function Remove-FileCommand {
-	[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_remove-githubactionsfilecommand#Remove-GitHubActionsFileCommand')]
-	[OutputType([Void])]
-	Param (
-		[Parameter(Mandatory = $True, Position = 0)][Alias('Types')][GitHubActionsFileCommandTypes]$Type
-	)
-	If (($Type -band [GitHubActionsFileCommandTypes]::EnvironmentVariable) -ieq [GitHubActionsFileCommandTypes]::EnvironmentVariable) {
-		Remove-Item -LiteralPath $Env:GITHUB_ENV -Confirm:$False -ErrorAction 'Continue'
-	}
-	If (($Type -band [GitHubActionsFileCommandTypes]::Output) -ieq [GitHubActionsFileCommandTypes]::Output) {
-		Remove-Item -LiteralPath $Env:GITHUB_OUTPUT -Confirm:$False -ErrorAction 'Continue'
-	}
-	If (($Type -band [GitHubActionsFileCommandTypes]::Path) -ieq [GitHubActionsFileCommandTypes]::Path) {
-		Remove-Item -LiteralPath $Env:GITHUB_PATH -Confirm:$False -ErrorAction 'Continue'
-	}
-	If (($Type -band [GitHubActionsFileCommandTypes]::State) -ieq [GitHubActionsFileCommandTypes]::State) {
-		Remove-Item -LiteralPath $Env:GITHUB_STATE -Confirm:$False -ErrorAction 'Continue'
-	}
-	If (($Type -band [GitHubActionsFileCommandTypes]::StepSummary) -ieq [GitHubActionsFileCommandTypes]::StepSummary) {
-		Remove-Item -LiteralPath $Env:GITHUB_STEP_SUMMARY -Confirm:$False -ErrorAction 'Continue'
-	}
-}
-<#
-.SYNOPSIS
 GitHub Actions - Write Command
 .DESCRIPTION
 Write command to communicate with the runner machine.
@@ -163,7 +163,7 @@ Function Write-FileCommand {
 	}
 }
 Export-ModuleMember -Function @(
-	'Remove-FileCommand',
+	'Clear-FileCommand',
 	'Write-Command',
 	'Write-FileCommand'
 )

hugoalh.GitHubActionsToolkit/module/step-summary.psm1

@@ -2,6 +2,7 @@
 #Requires -Version 7.2
 Import-Module -Name (
 	@(
+		'command-base.psm1',
 		'utility.psm1'
 	) |
 		ForEach-Object -Process { Join-Path -Path $PSScriptRoot -ChildPath $_ }
@@ -261,11 +262,7 @@ Function Remove-StepSummary {
 	[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_remove-githubactionsstepsummary#Remove-GitHubActionsStepSummary')]
 	[OutputType([Void])]
 	Param ()
-	If (!(Test-GitHubActionsEnvironment -StepSummary)) {
-		Write-Error -Message 'Unable to get GitHub Actions step summary resources!' -Category 'ResourceUnavailable'
-		Return
-	}
-	Remove-Item -LiteralPath $Env:GITHUB_STEP_SUMMARY -Confirm:$False -ErrorAction 'Continue'
+	Clear-GitHubActionsFileCommand -Type 'StepSummary'
 }
 <#
 .SYNOPSIS