20221012A

Author: hugoalh

hugoalh.GitHubActionsToolkit/module/cache.psm1

@@ -15,23 +15,23 @@ Restore cache that shared data from past job in the same workflow.
 .PARAMETER Key
 Key of the cache.
 .PARAMETER Path
-Path of the destination of the cache.
+Paths of the cache.
 .PARAMETER LiteralPath
-Absolute literal path of the destination of the cache.
+Literal paths of the cache.
 .PARAMETER NotUseAzureSdk
-Whether to not use Azure Blob SDK to download caches that are stored on the Azure Blob Storage, this maybe affect the reliability and performance.
+Whether to not use Azure Blob SDK to download the cache that stored on the Azure Blob Storage, this maybe affect the reliability and performance.
 .PARAMETER DownloadConcurrency
-Number of parallel downloads (only for Azure SDK).
+Number of parallel downloads of the cache (only for Azure SDK).
 .PARAMETER Timeout
-Maximum time for each download request, by seconds (only for Azure SDK).
+Maximum time for each download request of the cache, by seconds (only for Azure SDK).
 .OUTPUTS
 [String] The key of the cache hit.
 #>
 Function Restore-Cache {
 	[CmdletBinding(DefaultParameterSetName = 'Path', HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_restore-githubactionscache#Restore-GitHubActionsCache')]
 	[OutputType([String])]
 	Param (
-		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][ValidateScript({ Test-CacheKey -InputObject $_ }, ErrorMessage = '`{0}` is not a valid GitHub Actions cache key, and/or more than 512 characters!')][Alias('Keys', 'Name', 'Names')][String[]]$Key,
+		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][Alias('Keys', 'Name', 'Names')][String[]]$Key,
 		[Parameter(Mandatory = $True, ParameterSetName = 'Path', Position = 1, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][SupportsWildcards()][Alias('File', 'Files', 'Paths')][String[]]$Path,
 		[Parameter(Mandatory = $True, ParameterSetName = 'LiteralPath', ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][Alias('LiteralFile', 'LiteralFiles', 'LiteralPaths', 'LP', 'PSPath', 'PSPaths')][String[]]$LiteralPath,
 		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('NoAzureSdk')][Switch]$NotUseAzureSdk,
@@ -48,19 +48,12 @@ Function Restore-Cache {
 		If ($NoOperation) {
 			Return
 		}
-		[String[]]$KeysProceed = @()
-		If ($Key.Count -igt 10) {
-			Write-Warning -Message 'Keys are limit to maximum count of 10! Only first 10 keys will be use.'
-			$KeysProceed += $Key |
-				Select-Object -First 10
-		}
-		Else {
-			$KeysProceed += $Key
-		}
 		[Hashtable]$InputObject = @{
-			PrimaryKey = $KeysProceed[0]
-			RestoreKey = $KeysProceed |
-				Select-Object -SkipIndex 0
+			PrimaryKey = $Key[0]
+			RestoreKey = (
+				$Key |
+					Select-Object -SkipIndex 0
+			) ?? @()
 			Path = ($PSCmdlet.ParameterSetName -ieq 'LiteralPath') ? (
 				$LiteralPath |
 					ForEach-Object -Process { [WildcardPattern]::Escape($_) }
@@ -90,19 +83,19 @@ Key of the cache.
 .PARAMETER Path
 Paths of the cache.
 .PARAMETER LiteralPath
-Cache literal path.
+Literal paths of the cache.
 .PARAMETER UploadChunkSizes
-Maximum chunk size, by KB.
+Maximum chunk size of the cache, by KB.
 .PARAMETER UploadConcurrency
-Number of parallel uploads.
+Number of parallel uploads of the cache.
 .OUTPUTS
 [String] Cache ID.
 #>
 Function Save-Cache {
 	[CmdletBinding(DefaultParameterSetName = 'Path', HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_save-githubactionscache#Save-GitHubActionsCache')]
 	[OutputType([String])]
 	Param (
-		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][ValidateScript({ Test-CacheKey -InputObject $_ }, ErrorMessage = '`{0}` is not a valid GitHub Actions cache key, and/or more than 512 characters!')][Alias('Name')][String]$Key,
+		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][Alias('Name')][String]$Key,
 		[Parameter(Mandatory = $True, ParameterSetName = 'Path', Position = 1, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][SupportsWildcards()][Alias('File', 'Files', 'Paths')][String[]]$Path,
 		[Parameter(Mandatory = $True, ParameterSetName = 'LiteralPath', ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][Alias('LiteralFile', 'LiteralFiles', 'LiteralPaths', 'LP', 'PSPath', 'PSPaths')][String[]]$LiteralPath,
 		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(1, 1MB)][Alias('ChunkSize', 'ChunkSizes', 'UploadChunkSize')][UInt32]$UploadChunkSizes,
@@ -140,9 +133,9 @@ Set-Alias -Name 'Export-Cache' -Value 'Save-Cache' -Option 'ReadOnly' -Scope 'Lo
 .SYNOPSIS
 GitHub Actions (Private) - Test Cache Key
 .DESCRIPTION
-Test GitHub Actions cache key whether is valid.
+Test the key of the GitHub Actions cache whether is valid.
 .PARAMETER InputObject
-GitHub Actions cache key that need to test.
+Key of the GitHub Actions cache that need to test.
 .OUTPUTS
 [Boolean] Test result.
 #>

hugoalh.GitHubActionsToolkit/module/command-base.psm1

@@ -60,9 +60,9 @@ Write command to communicate with the runner machine.
 .PARAMETER Command
 Command.
 .PARAMETER Parameter
-Command parameter.
+Parameters of the command.
 .PARAMETER Value
-Command value.
+Value of the command.
 .OUTPUTS
 [Void]
 #>
@@ -89,7 +89,7 @@ GitHub Actions (Private) - Write File Command
 .DESCRIPTION
 Write file command to communicate with the runner machine.
 .PARAMETER LiteralPath
-Literal path of the file.
+Literal path of the file command.
 .PARAMETER Name
 Name.
 .PARAMETER Value

hugoalh.GitHubActionsToolkit/module/command-control.psm1

@@ -29,7 +29,7 @@ Import-Module -Name (
 .SYNOPSIS
 GitHub Actions - Disable Echoing Commands
 .DESCRIPTION
-Disable echoing most of the commands, the log will not show the command itself; Secret `ACTIONS_STEP_DEBUG` will ignore this setting; When processing a command, it will still echo if there has any issues.
+Disable echoing most of the commands, the log will not show the command itself; Environment variable `ACTIONS_STEP_DEBUG` will ignore this setting; When processing a command, it will still echo if there has any issues.
 .OUTPUTS
 [Void]
 #>
@@ -60,9 +60,9 @@ GitHub Actions - Disable Processing Commands
 .DESCRIPTION
 Disable processing any commands, to allow log anything without accidentally execute any commands.
 .PARAMETER EndToken
-An end token for function `Enable-GitHubActionsProcessingCommands`.
+An end token for the function `Enable-GitHubActionsProcessingCommands`.
 .OUTPUTS
-[String] An end token for function `Enable-GitHubActionsProcessingCommands`.
+[String] An end token for the function `Enable-GitHubActionsProcessingCommands`.
 #>
 Function Disable-ProcessingCommands {
 	[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_disable-githubactionsprocessingcommands#Disable-GitHubActionsProcessingCommands')]
@@ -92,7 +92,7 @@ Set-Alias -Name 'Stop-ProcessingCommands' -Value 'Disable-ProcessingCommands' -O
 .SYNOPSIS
 GitHub Actions - Enable Echoing Commands
 .DESCRIPTION
-Enable echoing most of the commands, the log will show the command itself; Secret `ACTIONS_STEP_DEBUG` will ignore this setting.
+Enable echoing most of the commands, the log will show the command itself; Environment variable `ACTIONS_STEP_DEBUG` will ignore this setting.
 .OUTPUTS
 [Void]
 #>
@@ -123,7 +123,7 @@ GitHub Actions - Enable Processing Commands
 .DESCRIPTION
 Enable processing any commands, to allow execute any commands.
 .PARAMETER EndToken
-An end token from function `Disable-GitHubActionsProcessingCommands`.
+An end token from the function `Disable-GitHubActionsProcessingCommands`.
 .OUTPUTS
 [Void]
 #>
@@ -173,7 +173,7 @@ Function New-CommandsEndToken {
 .SYNOPSIS
 GitHub Actions (Private) - Test Processing Commands End Token
 .DESCRIPTION
-Test GitHub Actions processing commands end token whether is valid.
+Test the GitHub Actions processing commands end token whether is valid.
 .PARAMETER InputObject
 GitHub Actions processing commands end token that need to test.
 .OUTPUTS

hugoalh.GitHubActionsToolkit/module/environment-variable.psm1

@@ -14,13 +14,13 @@ Import-Module -Name (
 .SYNOPSIS
 GitHub Actions - Add PATH
 .DESCRIPTION
-Add PATH to current step and all subsequent steps in the current job.
+Add PATH to the current step and/or all subsequent steps in the current job.
 .PARAMETER Path
-Path.
+Absolute paths.
 .PARAMETER NoValidator
-Do not check the PATH whether is valid.
+Whether to not check the paths are valid.
 .PARAMETER Scope
-Scope of PATH.
+Scope of the PATHs.
 .OUTPUTS
 [Void]
 #>
@@ -29,14 +29,14 @@ Function Add-PATH {
 	[OutputType([Void])]
 	Param (
 		[Parameter(Mandatory = $True, Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `Path` must be in single line string!')][Alias('Paths')][String[]]$Path,
-		[Alias('NoValidate', 'SkipValidate', 'SkipValidator')][Switch]$NoValidator,
-		[Alias('Scopes')][GitHubActionsEnvironmentVariableScopes]$Scope = [GitHubActionsEnvironmentVariableScopes]3
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('NoValidate', 'SkipValidate', 'SkipValidator')][Switch]$NoValidator,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Scopes')][GitHubActionsEnvironmentVariableScopes]$Scope = [GitHubActionsEnvironmentVariableScopes]3
 	)
 	Begin {
 		[Boolean]$Legacy = [String]::IsNullOrWhiteSpace($Env:GITHUB_PATH)
-		[String[]]$ScopeArray = $Scope.ToString() -isplit ', '
 	}
 	Process {
+		[String[]]$ScopeArray = $Scope.ToString() -isplit ', '
 		ForEach ($Item In (
 			$Path |
 				Select-Object -Unique
@@ -65,17 +65,17 @@ Function Add-PATH {
 .SYNOPSIS
 GitHub Actions - Set Environment Variable
 .DESCRIPTION
-Set environment variable to current step and all subsequent steps in the current job.
+Set environment variable to the current step and/or all subsequent steps in the current job.
 .PARAMETER InputObject
 Environment variables.
 .PARAMETER Name
-Environment variable name.
+Name of the environment variable.
 .PARAMETER Value
-Environment variable value.
+Value of the environment variable.
 .PARAMETER NoToUpper
-Do not format environment variable name to uppercase.
+Whether to not format names of the environment variable to the uppercase.
 .PARAMETER Scope
-Scope of environment variable.
+Scope of the environment variables.
 .OUTPUTS
 [Void]
 #>
@@ -86,14 +86,14 @@ Function Set-EnvironmentVariable {
 		[Parameter(Mandatory = $True, ParameterSetName = 'Multiple', Position = 0, ValueFromPipeline = $True)][Alias('Input', 'Object')][Hashtable]$InputObject,
 		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 0, ValueFromPipelineByPropertyName = $True)][ValidateScript({ Test-EnvironmentVariableName -InputObject $_ }, ErrorMessage = '`{0}` is not a valid environment variable name!')][Alias('Key')][String]$Name,
 		[Parameter(Mandatory = $True, ParameterSetName = 'Single', Position = 1, ValueFromPipelineByPropertyName = $True)][String]$Value,
-		[Alias('NoToUppercase')][Switch]$NoToUpper,
-		[Alias('Scopes')][GitHubActionsEnvironmentVariableScopes]$Scope = [GitHubActionsEnvironmentVariableScopes]3
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('NoToUppercase')][Switch]$NoToUpper,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Scopes')][GitHubActionsEnvironmentVariableScopes]$Scope = [GitHubActionsEnvironmentVariableScopes]3
 	)
 	Begin {
 		[Boolean]$Legacy = [String]::IsNullOrWhiteSpace($Env:GITHUB_ENV)
-		[String[]]$ScopeArray = $Scope.ToString() -isplit ', '
 	}
 	Process {
+		[String[]]$ScopeArray = $Scope.ToString() -isplit ', '
 		Switch ($PSCmdlet.ParameterSetName) {
 			'Multiple' {
 				ForEach ($Item In $InputObject.GetEnumerator()) {
@@ -140,9 +140,9 @@ Set-Alias -Name 'Set-Environment' -Value 'Set-EnvironmentVariable' -Option 'Read
 .SYNOPSIS
 GitHub Actions (Private) - Test Environment Variable Name
 .DESCRIPTION
-Test environment variable name whether is valid.
+Test the name of the environment variable whether is valid.
 .PARAMETER InputObject
-Environment variable name that need to test.
+Name of the environment variable that need to test.
 .OUTPUTS
 [Boolean] Test result.
 #>