20220703B

Author: hugoalh

hugoalh.GitHubActionsToolkit/module/artifact.psm1

@@ -20,7 +20,7 @@ A (literal) path that denote the base root directory of the files for control fi
 .PARAMETER ContinueOnIssue
 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 RetentionTime
-Duration of artifact expire by days.
+Duration of artifact expire, by days.
 .OUTPUTS
 [PSCustomObject] Exported artifact's metadata.
 #>

hugoalh.GitHubActionsToolkit/module/cache.psm1

@@ -20,7 +20,7 @@ Do not use Azure Blob SDK to download caches that are stored on Azure Blob Stora
 .PARAMETER DownloadConcurrency
 Number of parallel downloads (only for Azure SDK).
 .PARAMETER Timeout
-Maximum time for each download request by seconds (only for Azure SDK).
+Maximum time for each download request, by seconds (only for Azure SDK).
 .OUTPUTS
 [String] The key of the cache hit.
 #>
@@ -32,7 +32,7 @@ Function Restore-Cache {
 		[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,
-		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(1, 16)][Byte]$DownloadConcurrency = 0,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(1, 16)][Alias('Concurrency')][Byte]$DownloadConcurrency = 0,
 		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(5, 900)][UInt16]$Timeout = 0
 	)
 	Begin {
@@ -90,7 +90,7 @@ Cache path.
 .PARAMETER LiteralPath
 Cache literal path.
 .PARAMETER UploadChunkSizes
-Maximum chunk size by bytes.
+Maximum chunk size, by KB.
 .PARAMETER UploadConcurrency
 Number of parallel uploads.
 .OUTPUTS
@@ -103,8 +103,8 @@ Function Save-Cache {
 		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][ValidateScript({ Return (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, 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(1KB, 1GB)][UInt32]$UploadChunkSizes = 0,
-		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(1, 16)][Byte]$UploadConcurrency = 0
+		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(1, 1MB)][Alias('ChunkSize', 'ChunkSizes', 'UploadChunkSize')][UInt32]$UploadChunkSizes = 0,
+		[Parameter(ValueFromPipelineByPropertyName = $True)][ValidateRange(1, 16)][Alias('Concurrency')][Byte]$UploadConcurrency = 0
 	)
 	Begin {
 		[Boolean]$NoOperation = $False# When the requirements are not fulfill, only stop this function but not others.
@@ -124,7 +124,7 @@ Function Save-Cache {
 			}) : $Path
 		}
 		If ($UploadChunkSizes -igt 0) {
-			$InputObject.UploadChunkSizes = $UploadChunkSizes
+			$InputObject.UploadChunkSizes = $UploadChunkSizes * 1KB
 		}
 		If ($UploadConcurrency -igt 0) {
 			$InputObject.UploadConcurrency = $UploadConcurrency

hugoalh.GitHubActionsToolkit/module/step-summary.psm1

@@ -85,9 +85,9 @@ Image title.
 .PARAMETER AlternativeText
 Image alternative text.
 .PARAMETER Width
-Image width, by pixels.
+Image width, by pixels (px).
 .PARAMETER Height
-Image height, by pixels.
+Image height, by pixels (px).
 .PARAMETER NoNewLine
 Do not add a new line or carriage return to the content, the string representations of the input objects are concatenated to form the output, no spaces or newlines are inserted between the output strings, no newline is added after the last output string.
 .OUTPUTS

hugoalh.GitHubActionsToolkit/module/tool-cache.psm1

@@ -104,9 +104,9 @@ Find the path of a tool in the local installed tool cache.
 .PARAMETER Name
 Tool name.
 .PARAMETER Version
-Tool version, by Semantic Versioning (SemVer).
+Tool version, by Semantic Versioning (SemVer); Default to all versions.
 .PARAMETER Architecture
-Tool architecture.
+Tool architecture; Default to current machine architecture.
 .OUTPUTS
 [String] Path of a version of a tool.
 [String[]] Paths of all versions of a tool.
@@ -219,7 +219,7 @@ Tool name.
 .PARAMETER Version
 Tool version, by Semantic Versioning (SemVer).
 .PARAMETER Architecture
-Tool architecture.
+Tool architecture; Default to current machine architecture.
 .OUTPUTS
 [String] Tool cached path.
 #>
@@ -273,7 +273,7 @@ Tool name.
 .PARAMETER Version
 Tool version, by Semantic Versioning (SemVer).
 .PARAMETER Architecture
-Tool architecture.
+Tool architecture; Default to current machine architecture.
 .OUTPUTS
 [String] Tool cached path.
 #>