Skip to content

Commit 80a3880

Browse files
hugoalhhugoalh
committed
Update descriptions
1 parent 236bec9 commit 80a3880

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

‎hugoalh.GitHubActionsToolkit/module/artifact.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Name of the artifact.
8989
.PARAMETER CreateSubfolder
9090
Whether to create a subfolder with artifact name and put the data into there.
9191
.PARAMETER All
92-
Import all of the artifacts that shared the data from the past jobs in the same workflow; Always create subfolders.
92+
Whether to import all of the artifacts that shared the data from the past jobs in the same workflow; Always create subfolders.
9393
.PARAMETER Destination
9494
Absolute literal path of the destination of the artifact(s).
9595
.OUTPUTS

‎hugoalh.GitHubActionsToolkit/module/environment-variable.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Value of the environment variable.
7373
.PARAMETER NoToUpper
7474
Whether to not format names of the environment variable to the upper case.
7575
.PARAMETER Scope
76-
Scope of the environment variables.
76+
Scope of the environment variable(s).
7777
.OUTPUTS
7878
[Void]
7979
#>

‎hugoalh.GitHubActionsToolkit/module/log.psm1

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@ Function Write-Annotation {
8181
Param (
8282
[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][GitHubActionsAnnotationType]$Type,
8383
[Parameter(Mandatory = $True, Position = 1, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][Alias('Content')][String]$Message,
84-
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.*$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
84+
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
8585
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('LineStart', 'StartLine')][UInt32]$Line,
8686
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Col', 'ColStart', 'ColumnStart', 'StartCol', 'StartColumn')][UInt32]$Column,
8787
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('LineEnd')][UInt32]$EndLine,
8888
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('ColEnd', 'ColumnEnd', 'EndCol')][UInt32]$EndColumn,
89-
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.*$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
89+
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
9090
)
9191
Process {
9292
Switch ($Type.GetHashCode()) {
@@ -172,12 +172,12 @@ Function Write-Error {
172172
[OutputType([Void])]
173173
Param (
174174
[Parameter(Mandatory = $True, Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][Alias('Content')][String]$Message,
175-
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.*$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
175+
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
176176
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('LineStart', 'StartLine')][UInt32]$Line,
177177
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Col', 'ColStart', 'ColumnStart', 'StartCol', 'StartColumn')][UInt32]$Column,
178178
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('LineEnd')][UInt32]$EndLine,
179179
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('ColEnd', 'ColumnEnd', 'EndCol')][UInt32]$EndColumn,
180-
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.*$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
180+
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
181181
)
182182
Process {
183183
Write-Annotation -Type 'Error' -Message $Message -File $File -Line $Line -Column $Column -EndLine $EndLine -EndColumn $EndColumn -Title $Title
@@ -210,12 +210,12 @@ Function Write-Fail {
210210
[OutputType([Void])]
211211
Param (
212212
[Parameter(Mandatory = $True, Position = 0)][Alias('Content')][String]$Message,
213-
[ValidatePattern('^.*$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
213+
[ValidatePattern('^.+$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
214214
[Alias('LineStart', 'StartLine')][UInt32]$Line,
215215
[Alias('Col', 'ColStart', 'ColumnStart', 'StartCol', 'StartColumn')][UInt32]$Column,
216216
[Alias('LineEnd')][UInt32]$EndLine,
217217
[Alias('ColEnd', 'ColumnEnd', 'EndCol')][UInt32]$EndColumn,
218-
[ValidatePattern('^.*$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
218+
[ValidatePattern('^.+$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
219219
)
220220
Write-Annotation -Type 'Error' -Message $Message -File $File -Line $Line -Column $Column -EndLine $EndLine -EndColumn $EndColumn -Title $Title
221221
Exit 1
@@ -247,12 +247,12 @@ Function Write-Notice {
247247
[OutputType([Void])]
248248
Param (
249249
[Parameter(Mandatory = $True, Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][Alias('Content')][String]$Message,
250-
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.*$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
250+
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
251251
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('LineStart', 'StartLine')][UInt32]$Line,
252252
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Col', 'ColStart', 'ColumnStart', 'StartCol', 'StartColumn')][UInt32]$Column,
253253
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('LineEnd')][UInt32]$EndLine,
254254
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('ColEnd', 'ColumnEnd', 'EndCol')][UInt32]$EndColumn,
255-
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.*$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
255+
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
256256
)
257257
Process {
258258
Write-Annotation -Type 'Notice' -Message $Message -File $File -Line $Line -Column $Column -EndLine $EndLine -EndColumn $EndColumn -Title $Title
@@ -321,12 +321,12 @@ Function Write-Warning {
321321
[OutputType([Void])]
322322
Param (
323323
[Parameter(Mandatory = $True, Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True)][Alias('Content')][String]$Message,
324-
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.*$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
324+
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `File` must be in single line string!')][Alias('Path')][String]$File,
325325
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('LineStart', 'StartLine')][UInt32]$Line,
326326
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Col', 'ColStart', 'ColumnStart', 'StartCol', 'StartColumn')][UInt32]$Column,
327327
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('LineEnd')][UInt32]$EndLine,
328328
[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('ColEnd', 'ColumnEnd', 'EndCol')][UInt32]$EndColumn,
329-
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.*$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
329+
[Parameter(ValueFromPipelineByPropertyName = $True)][ValidatePattern('^.+$', ErrorMessage = 'Parameter `Title` must be in single line string!')][Alias('Header')][String]$Title
330330
)
331331
Process {
332332
Write-Annotation -Type 'Warning' -Message $Message -File $File -Line $Line -Column $Column -EndLine $EndLine -EndColumn $EndColumn -Title $Title

‎hugoalh.GitHubActionsToolkit/module/tool-cache.psm1

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ Path for the expand destination.
1919
.PARAMETER Method
2020
Method to expand compressed archive/file; Define this parameter will enforce to use defined method.
2121
.PARAMETER 7zrPath
22-
Path of the 7zr application, for long path support (only when parameter `Method` is `7z`).
22+
Literal path of the 7zr application, for long path support (only when parameter `Method` is `7z`).
2323
24-
Most `.7z` archives do not have this problem, if `.7z` archive contains very long path, pass the path to `7zr` which will gracefully handle long paths, by default `7zdec` is used because it is a very small program and is bundled with the GitHub Actions NodeJS toolkit, however it does not support long paths, `7zr` is the reduced command line interface, it is smaller than the full command line interface, and it does support long paths, at the time of this writing, it is freely available from the LZMA SDK that is available on the 7-Zip website, be sure to check the current license agreement, if `7zr` is bundled with your action, then the path to `7zr` can be pass to this function.
24+
Most `.7z` archives do not have this problem, if `.7z` archive contains very long path, pass the path to 7zr which will gracefully handle long paths, by default 7zdec is used because it is a very small program and is bundled with the GitHub Actions NodeJS toolkit, however it does not support long paths, 7zr is the reduced command line interface, it is smaller than the full command line interface, and it does support long paths, at the time of this writing, it is freely available from the LZMA SDK that is available on the 7-Zip website, be sure to check the current license agreement, if 7zr is bundled with your action, then the path to 7zr can be pass to this function.
2525
.PARAMETER Flag
2626
Flag to use for expand (only when parameter `Method` is `Tar` or `Xar`).
2727
.OUTPUTS
28-
[String] Path of the expand destination.
28+
[String] Absolute path of the expand destination.
2929
#>
3030
Function Expand-ToolCacheCompressedFile {
3131
[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_expand-githubactionstoolcachecompressedfile#Expand-GitHubActionsToolCacheCompressedFile')]
@@ -106,8 +106,8 @@ Version of the tool, by Semantic Versioning (SemVer); Default to all of the vers
106106
.PARAMETER Architecture
107107
Architecture of the tool; Default to the architecture of the current machine.
108108
.OUTPUTS
109-
[String] Path of a version of a tool.
110-
[String[]] Paths of all of the versions of a tool.
109+
[String] Absolute path of a version of a tool.
110+
[String[]] Absolute paths of all of the versions of a tool.
111111
#>
112112
Function Find-ToolCache {
113113
[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_find-githubactionstoolcache#Find-GitHubActionsToolCache')]
@@ -158,7 +158,7 @@ Authorization of the URI request.
158158
.PARAMETER Header
159159
Header of the URI request.
160160
.OUTPUTS
161-
[String] Path of the downloaded tool.
161+
[String] Absolute path of the downloaded tool.
162162
#>
163163
Function Invoke-ToolCacheToolDownloader {
164164
[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_invoke-githubactionstoolcachetooldownloader#Invoke-GitHubActionsToolCacheToolDownloader')]
@@ -209,7 +209,7 @@ Version for the tool, by Semantic Versioning (SemVer).
209209
.PARAMETER Architecture
210210
Architecture for the tool; Default to the architecture of the current machine.
211211
.OUTPUTS
212-
[String] Path of the tool cached.
212+
[String] Absolute path of the tool cached.
213213
#>
214214
Function Register-ToolCacheDirectory {
215215
[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_register-githubactionstoolcachedirectory#Register-GitHubActionsToolCacheDirectory')]
@@ -258,7 +258,7 @@ Version for the tool, by Semantic Versioning (SemVer).
258258
.PARAMETER Architecture
259259
Architecture for the tool; Default to the architecture of the current machine.
260260
.OUTPUTS
261-
[String] Path of the tool cached.
261+
[String] Absolute path of the tool cached.
262262
#>
263263
Function Register-ToolCacheFile {
264264
[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_register-githubactionstoolcachefile#Register-GitHubActionsToolCacheFile')]

0 commit comments

Comments
 (0)