Refactor 2

Author: hugoalh

README.md

@@ -15,7 +15,7 @@ A PowerShell module to provide a better and easier way for GitHub Actions to com
 ### PowerShell
 
 - **Target Version:** >= v7.2.0, &:
-  - GitHub Actions Runner >= v2.308.0
+  - GitHub Actions Runner >= v2.310.0
   - NodeJS >= v16.13.0 *\[Optional, for NodeJS based wrapper API\]*
 - **Domain/Registry:**
   - [PowerShell Gallery](https://www.powershellgallery.com/packages/hugoalh.GitHubActionsToolkit)
@@ -37,12 +37,12 @@ A PowerShell module to provide a better and easier way for GitHub Actions to com
 - `Add-GitHubActionsPATH`
 - `Add-GitHubActionsProblemMatcher`
 - `Add-GitHubActionsSecretMask`
-- `Add-GitHubActionsStepSummary`
-- `Add-GitHubActionsStepSummaryHeader`
-- `Add-GitHubActionsStepSummaryImage`
-- `Add-GitHubActionsStepSummaryLink`
-- `Add-GitHubActionsStepSummarySubscriptText`
-- `Add-GitHubActionsStepSummarySuperscriptText`
+- `Add-GitHubActionsSummary`
+- `Add-GitHubActionsSummaryHeader`
+- `Add-GitHubActionsSummaryImage`
+- `Add-GitHubActionsSummaryLink`
+- `Add-GitHubActionsSummarySubscriptText`
+- `Add-GitHubActionsSummarySuperscriptText`
 - `Disable-GitHubActionsStdOutCommandEcho`
 - `Disable-GitHubActionsStdOutCommandProcess`
 - `Enable-GitHubActionsStdOutCommandEcho`
@@ -56,7 +56,7 @@ A PowerShell module to provide a better and easier way for GitHub Actions to com
 - `Get-GitHubActionsInput`
 - `Get-GitHubActionsOpenIdConnectToken`
 - `Get-GitHubActionsState`
-- `Get-GitHubActionsStepSummary`
+- `Get-GitHubActionsSummary`
 - `Get-GitHubActionsWebhookEventPayload`
 - `Get-GitHubActionsWorkflowRunUri`
 - `Import-GitHubActionsArtifact`
@@ -69,15 +69,12 @@ A PowerShell module to provide a better and easier way for GitHub Actions to com
 - `Set-GitHubActionsEnvironmentVariable`
 - `Set-GitHubActionsOutput`
 - `Set-GitHubActionsState`
-- `Set-GitHubActionsStepSummary`
+- `Set-GitHubActionsSummary`
 - `Test-GitHubActionsEnvironment`
-- `Test-GitHubActionsNodeJsEnvironment`
-- `Write-GitHubActionsAnnotation`
 - `Write-GitHubActionsDebug`
 - `Write-GitHubActionsError`
 - `Write-GitHubActionsFail`
 - `Write-GitHubActionsNotice`
-- `Write-GitHubActionsRaw`
 - `Write-GitHubActionsWarning`
 
 ## ✍️ Example

SECURITY.md

@@ -13,6 +13,7 @@
 
 | **Versions** | **Status** | **Target - GitHub Actions Runner** | **Target - PowerShell** | **Target - NodeJS (Wrapper API)** | **Target - NPM (Wrapper API)** |
 |:-:|:-:|:-:|:-:|:-:|:-:|
+| v2.X.X | L | >= v2.310.0 | >= v7.2.0 | >= v16.13.0 | *N/A* |
 | v1.X.X | L | >= v2.308.0 | >= v7.2.0 | >= v16.13.0 | *N/A* |
 | v1.4.X \~ v1.7.X | ✔️ | >= v2.303.0 | >= v7.2.0 | >= v14.15.0 | *N/A* |
 | v1.3.X | ❌{🐛🧓} | *Unspecified* | >= v7.2.0 | >= v14.15.0 | >= v6.14.8 |

_get-package-members.ps1

@@ -3,7 +3,9 @@
 This script is help for copy members to the file `hugoalh.GitHubActionsToolkit.psd1` for best performance, and use for debug.
 #>
 [String]$PackageName = 'hugoalh.GitHubActionsToolkit'
-Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath $PackageName -AdditionalChildPath @("$PackageName.psm1")) -Scope 'Local'
+Import-Module -Name @(
+	(Join-Path -Path $PSScriptRoot -ChildPath "$PackageName\$PackageName.psm1")
+) -Scope 'Local'
 [PSCustomObject[]]$PackageCommands = Get-Command -Module $PackageName -ListImported
 ForEach ($CommandType In @('Function', 'Alias')) {
 	$PackageCommands |

hugoalh.GitHubActionsToolkit/hugoalh.GitHubActionsToolkit.psd1

@@ -3,7 +3,7 @@
 	RootModule = 'hugoalh.GitHubActionsToolkit.psm1'
 
 	# Version number of this module.
-	ModuleVersion = '1.8.0'
+	ModuleVersion = '2.0.0'
 
 	# Supported PSEditions
 	# CompatiblePSEditions = @()
@@ -64,16 +64,18 @@
 		'Add-PATH',
 		'Add-ProblemMatcher',
 		'Add-SecretMask',
-		'Add-StepSummary',
-		'Add-StepSummaryHeader',
-		'Add-StepSummaryImage',
-		'Add-StepSummaryLink',
-		'Add-StepSummarySubscriptText',
-		'Add-StepSummarySuperscriptText',
+		'Add-Summary',
+		'Add-SummaryHeader',
+		'Add-SummaryImage',
+		'Add-SummaryLink',
+		'Add-SummarySubscriptText',
+		'Add-SummarySuperscriptText',
+		'Clear-EnvironmentVariable',
 		'Clear-FileCommand',
 		'Clear-Output',
+		'Clear-PATH',
 		'Clear-State',
-		'Clear-StepSummary',
+		'Clear-Summary',
 		'ConvertFrom-CsvM',
 		'ConvertFrom-CsvS',
 		'Disable-StdOutCommandEcho',
@@ -85,15 +87,15 @@
 		'Expand-ToolCacheCompressedFile',
 		'Export-Artifact',
 		'Find-ToolCache',
+		'Format-Markdown',
 		'Get-DebugStatus',
 		'Get-Input',
 		'Get-OpenIdConnectToken',
 		'Get-State',
-		'Get-StepSummary',
+		'Get-Summary',
 		'Get-WebhookEventPayload',
 		'Get-WorkflowRunUri',
 		'Import-Artifact',
-		'Invoke-NodeJsWrapper',
 		'Invoke-ToolCacheToolDownloader',
 		'Register-ToolCacheDirectory',
 		'Register-ToolCacheFile',
@@ -103,16 +105,13 @@
 		'Set-EnvironmentVariable',
 		'Set-Output',
 		'Set-State',
-		'Set-StepSummary',
+		'Set-Summary',
 		'Test-Environment',
-		'Test-NodeJsEnvironment',
-		'Write-Annotation',
 		'Write-Debug',
 		'Write-Error',
 		'Write-Fail',
 		'Write-FileCommand',
 		'Write-Notice',
-		'Write-Raw',
 		'Write-StdOutCommand',
 		'Write-Warning'
 	)
@@ -127,20 +126,18 @@
 	AliasesToExport = @(
 		'Add-Mask',
 		'Add-Secret',
-		'Add-StepSummaryHyperlink',
-		'Add-StepSummaryPicture',
-		'Add-StepSummaryRaw',
-		'Add-StepSummarySubscript',
-		'Add-StepSummarySuperscript',
+		'Add-SummaryHyperlink',
+		'Add-SummaryPicture',
+		'Add-SummaryRaw',
+		'Add-SummarySubscript',
+		'Add-SummarySuperscript',
 		'Disable-CommandEcho',
 		'Disable-CommandProcess',
 		'Enable-CommandEcho',
 		'Enable-CommandProcess',
 		'Enter-Group',
 		'Exit-Group',
 		'Expand-ToolCacheArchive',
-		'Expand-ToolCacheCompressedArchive',
-		'Expand-ToolCacheFile',
 		'Export-Cache',
 		'Get-Event',
 		'Get-EventPayload',
@@ -151,18 +148,20 @@
 		'Get-WebhookPayload',
 		'Get-WorkflowRunUrl',
 		'Import-Cache',
+		'Remove-Env',
+		'Remove-EnvironmentVariable',
 		'Remove-FileCommand',
 		'Remove-Output',
+		'Remove-PATH',
 		'Remove-State',
-		'Remove-StepSummary',
+		'Remove-Summary',
 		'Restore-Artifact',
 		'Restore-State',
 		'Resume-CommandProcess',
 		'Resume-StdOutCommandProcess',
 		'Save-Artifact',
 		'Save-State',
 		'Set-Env',
-		'Set-Environment',
 		'Start-CommandEcho',
 		'Start-CommandProcess',
 		'Start-StdOutCommandEcho',

hugoalh.GitHubActionsToolkit/hugoalh.GitHubActionsToolkit.psm1

@@ -2,22 +2,21 @@
 [String[]]$ModulesName = @(
 	'artifact',
 	'cache',
-	'command-base',
-	'command-control',
+	'command-file',
+	'command-stdout',
 	'environment-variable',
 	'log',
 	'markup',
-	'nodejs-wrapper',
 	'open-id-connect',
 	'parameter',
 	'problem-matcher',
-	'step-summary',
+	'summary',
 	'tool-cache',
 	'utility'
 )
 Import-Module -Name (
 	$ModulesName |
-		ForEach-Object -Process { Join-Path -Path $PSScriptRoot -ChildPath 'module' -AdditionalChildPath @("$_.psm1") }
+		ForEach-Object -Process { Join-Path -Path $PSScriptRoot -ChildPath "module\$_.psm1" }
 ) -Scope 'Local'
 [PSCustomObject[]]$PackageCommands = Get-Command -Module $ModulesName -ListImported
 [String[]]$PackageFunctions = $PackageCommands |

hugoalh.GitHubActionsToolkit/module/artifact.psm1

@@ -1,15 +1,12 @@
 #Requires -PSEdition Core -Version 7.2
-Import-Module -Name (
-	@(
-		'nodejs-wrapper'
-	) |
-		ForEach-Object -Process { Join-Path -Path $PSScriptRoot -ChildPath "$_.psm1" }
+Import-Module -Name @(
+	(Join-Path -Path $PSScriptRoot -ChildPath 'internal\nodejs-wrapper.psm1')
 ) -Prefix 'GitHubActions' -Scope 'Local'
 <#
 .SYNOPSIS
 GitHub Actions - Export Artifact
 .DESCRIPTION
-Export artifact to persist the data and/or share with the future jobs in the same workflow.
+Export artifact to share with all of the subsequent jobs in the same workflow, and/or persist the data.
 .PARAMETER Name
 Name of the artifact.
 .PARAMETER Path
@@ -18,49 +15,66 @@ Path of the files that need to export as artifact.
 Literal path of the files that need to export as artifact.
 .PARAMETER RootDirectory
 Absolute literal path of the root directory of the files for control files structure.
-.PARAMETER ContinueOnError
-Whether the export should continue in the event of files fail to export; If not set and issue is encountered, export will stop and queued files will not export, the partial artifact availables which include files up until the issue; If set and issue is encountered, the issue file will ignore and skip, and queued files will still export, the partial artifact availables which include everything but exclude issue files.
 .PARAMETER RetentionDays
-Retention days of the artifact.
+Retention days of the artifact, override the default value.
+.PARAMETER FailFast
+Whether to stop export artifact if any of file fail to export due to any of error.
+
+By default, the failed files will skip and ignore, and all of the queued files will still export; The partial artifact will have all of the files except the failed files.
+
+When enable, export will stop, include all of the queued files; The partial artifact will have files up until the failure.
+
+A partial artifact will always associate and available at the end, and the size reported will be the amount of storage that the organization or user will charge for this partial artifact.
 .OUTPUTS
 [PSCustomObject] Metadata of the exported artifact.
 #>
 Function Export-Artifact {
 	[CmdletBinding(DefaultParameterSetName = 'Path', HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_exportgithubactionsartifact')]
 	[OutputType([PSCustomObject])]
 	Param (
-		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][String]$Name,
-		[Parameter(Mandatory = $True, ParameterSetName = 'Path', Position = 1, ValueFromPipelineByPropertyName = $True)][SupportsWildcards()][Alias('File', 'Files', 'Paths')][String[]]$Path,
-		[Parameter(Mandatory = $True, ParameterSetName = 'LiteralPath', ValueFromPipelineByPropertyName = $True)][Alias('LiteralFile', 'LiteralFiles', 'LiteralPaths', 'LP', 'PSPath', 'PSPaths')][String[]]$LiteralPath,
-		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateScript({ [System.IO.Path]::IsPathRooted($_) -and (Test-Path -LiteralPath $_ -PathType 'Container') }, ErrorMessage = '`{0}` is not an exist and valid directory!')][Alias('BaseRoot', 'Root')][String]$RootDirectory = $Env:GITHUB_WORKSPACE,
-		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('ContinueOnIssue')][Switch]$ContinueOnError,
-		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(1, [Int16]::MaxValue)][Alias('RetentionDay', 'RetentionTime')][Int16]$RetentionDays
+		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Value is not a single line string!')][String]$Name,
+		[Parameter(Mandatory = $True, ParameterSetName = 'Path', Position = 1, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][SupportsWildcards()][ValidatePattern('^.+$', ErrorMessage = 'Value is not a single line string!')][Alias('File', 'Files', 'Paths')][String[]]$Path,
+		[Parameter(Mandatory = $True, ParameterSetName = 'LiteralPath', ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Value is not a single line string!')][Alias('LiteralFile', 'LiteralFiles', 'LiteralPaths', 'LP', 'PSPath', 'PSPaths')][String[]]$LiteralPath,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('BaseRoot', 'Root')][String]$RootDirectory = $Env:GITHUB_WORKSPACE,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('RetentionDay', 'RetentionTime')][UInt16]$RetentionDays,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Switch]$FailFast
 	)
 	Process {
+		If ($RootDirectory -inotmatch '^.+$') {
+			Write-Error -Message 'Parameter `RootDirectory` is not a single line string!' -Category 'SyntaxError'
+			Return
+		}
+		If (!([System.IO.Path]::IsPathFullyQualified($RootDirectory) -and (Test-Path -LiteralPath $RootDirectory -PathType 'Container'))) {
+			Write-Error -Message "``$RootDirectory`` is not a valid and exist directory!" -Category 'ResourceUnavailable'
+			Return
+		}
 		Switch ($PSCmdlet.ParameterSetName) {
 			'LiteralPath' {
-				[String[]]$Items = $LiteralPath |
-					ForEach-Object -Process { [System.IO.Path]::IsPathRooted($_) ? $_ : (Join-Path -Path $RootDirectory -ChildPath $_) }
+				[String[]]$Items = $LiteralPath
 			}
 			'Path' {
-				[String[]]$Items = $Path |
-					ForEach-Object -Process {
+				[String[]]$Items = @()
+				ForEach ($P In $Path) {
+					If ([WildcardPattern]::ContainsWildcardCharacters($P)) {
 						Try {
-							Resolve-Path -Path ([System.IO.Path]::IsPathRooted($_) ? $_ : (Join-Path -Path $RootDirectory -ChildPath $_)) |
-								Write-Output
+							$Items += Resolve-Path -Path ([System.IO.Path]::IsPathFullyQualified($P) ? $P : (Join-Path -Path $RootDirectory -ChildPath $P)) |
+								Select-Object -ExpandProperty 'Path'
 						}
 						Catch {
-							$_ |
-								Write-Output
+							$Items += $P
 						}
 					}
+					Else {
+						$Items += $P
+					}
+				}
 			}
 		}
 		[Hashtable]$Argument = @{
 			'name' = $Name
 			'items' = $Items
 			'rootDirectory' = $RootDirectory
-			'continueOnError' = $ContinueOnError.IsPresent
+			'continueOnError' = !$FailFast.IsPresent
 		}
 		If ($RetentionDays -gt 0) {
 			$Argument.('retentionDays') = $RetentionDays
@@ -74,43 +88,43 @@ Set-Alias -Name 'Save-Artifact' -Value 'Export-Artifact' -Option 'ReadOnly' -Sco
 .SYNOPSIS
 GitHub Actions - Import Artifact
 .DESCRIPTION
-Import artifact that shared the data from the past jobs in the same workflow.
+Import artifact that shared from the past jobs in the same workflow.
 .PARAMETER Name
 Name of the artifact.
-.PARAMETER CreateSubfolder
-Whether to create a subfolder with artifact name and put the data into there.
-.PARAMETER All
-Whether to import all of the artifacts that shared the data from the past jobs in the same workflow; Always create subfolders.
 .PARAMETER Destination
 Absolute literal path of the destination of the artifact(s).
+.PARAMETER CreateSubDirectory
+Whether to create a sub-directory with artifact name and put the data into there.
+.PARAMETER All
+Whether to import all of the artifacts that shared from the past jobs in the same workflow; Always create sub-directories.
 .OUTPUTS
 [PSCustomObject] Metadata of the imported artifact.
 [PSCustomObject[]] Metadata of the imported artifacts.
 #>
 Function Import-Artifact {
 	[CmdletBinding(DefaultParameterSetName = 'Single', HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_importgithubactionsartifact')]
-	[OutputType([PSCustomObject[]], ParameterSetName = 'All')]
 	[OutputType([PSCustomObject], ParameterSetName = 'Single')]
+	[OutputType([PSCustomObject[]], ParameterSetName = 'All')]
 	Param (
-		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][String]$Name,
-		[Parameter(ParameterSetName = 'Single', ValueFromPipelineByPropertyName = $True)][Switch]$CreateSubfolder,
-		[Parameter(Mandatory = $True, ParameterSetName = 'All')][Switch]$All,
-		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Dest', 'Path', 'Target')][String]$Destination = $Env:GITHUB_WORKSPACE
+		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Value is not a single line string!')][String]$Name,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Value is not a single line string!')][Alias('Dest', 'Path', 'Target')][String]$Destination,
+		[Parameter(ParameterSetName = 'Single', ValueFromPipelineByPropertyName = $True)][Switch]$CreateSubDirectory,
+		[Parameter(Mandatory = $True, ParameterSetName = 'All')][Switch]$All
 	)
 	Process {
+		[Hashtable]$Argument = @{}
+		If ($Destination.Length -gt 0) {
+			$Argument.('destination') = $Destination
+		}
 		Switch ($PSCmdlet.ParameterSetName) {
 			'All' {
-				Invoke-GitHubActionsNodeJsWrapper -Name 'artifact/download-all' -Argument @{
-					'destination' = $Destination
-				} |
-					Write-Output
+				Invoke-GitHubActionsNodeJsWrapper -Name 'artifact/download-all' -Argument $Argument |
+					Write-Output -NoEnumerate
 			}
 			'Single' {
-				Invoke-GitHubActionsNodeJsWrapper -Name 'artifact/download' -Argument @{
-					'name' = $Name
-					'destination' = $Destination
-					'createSubfolder' = $CreateSubfolder.IsPresent
-				} |
+				$Argument.('name') = $Name
+				$Argument.('createSubDirectory') = $CreateSubDirectory.IsPresent
+				Invoke-GitHubActionsNodeJsWrapper -Name 'artifact/download' -Argument $Argument |
 					Write-Output
 			}
 		}