20220628B

Author: hugoalh

hugoalh.GitHubActionsToolkit/module/command-base.psm1

@@ -44,6 +44,8 @@ Set-Alias -Name 'Format-CommandMessage' -Value 'Format-CommandValue' -Option 'Re
 GitHub Actions - Write Command
 .DESCRIPTION
 Write command to communicate with the runner machine.
+
+This is a major function that services most of the functions; This function also will be useful when GitHub Actions has new commands but this module has not include yet.
 .PARAMETER Command
 Command.
 .PARAMETER Value
@@ -59,7 +61,7 @@ Function Write-Command {
 	Param (
 		[Parameter(Mandatory = $True, Position = 0, ValueFromPipelineByPropertyName = $True)][ValidatePattern('^(?:[\da-z][\da-z_-]*)?[\da-z]$', ErrorMessage = '`{0}` is not a valid GitHub Actions command!')][String]$Command,
 		[Parameter(Position = 1, ValueFromPipelineByPropertyName = $True)][Alias('Content', 'Message')][String]$Value = '',
-		[Parameter(Position = 2, ValueFromPipelineByPropertyName = $True)][Alias('Parameters', 'Property', 'Properties')][Hashtable]$Parameter = @{}
+		[Parameter(Position = 2, ValueFromPipelineByPropertyName = $True)][Alias('Parameters', 'Properties', 'Property')][Hashtable]$Parameter = @{}
 	)
 	Begin {}
 	Process {

hugoalh.GitHubActionsToolkit/module/step-summary.psm1

@@ -211,7 +211,7 @@ GitHub Actions - Get Step Summary
 .DESCRIPTION
 Get step summary that previously added/setted from functions `Add-GitHubActionsStepSummary` and `Set-GitHubActionsStepSummary`.
 .PARAMETER Raw
-Ignore newline characters and return the entire contents of a file in one string with the newlines preserved. By default, newline characters in a file are used as delimiters to separate the input into an array of strings.
+Ignore newline characters and return the entire contents of a file in one string with the newlines preserved; By default, newline characters in a file are used as delimiters to separate the input into an array of strings.
 .PARAMETER Sizes
 Get step summary sizes instead of the content.
 .OUTPUTS
@@ -260,7 +260,9 @@ Function Remove-StepSummary {
 .SYNOPSIS
 GitHub Actions - Set Step Summary
 .DESCRIPTION
-Set some GitHub flavored Markdown for step so that it will display on the summary page of a run; Can use to display and group unique content, such as test result summaries, so that viewing the result of a run does not need to go into the logs to see important information related to the run, such as failures. When a run's job finishes, the summaries for all steps in a job are grouped together into a single job summary and are shown on the run summary page. If multiple jobs generate summaries, the job summaries are ordered by job completion time.
+Set some GitHub flavored Markdown for step so that it will display on the summary page of a run; Can use to display and group unique content, such as test result summaries, so that viewing the result of a run does not need to go into the logs to see important information related to the run, such as failures.
+
+When a run's job finishes, the summaries for all steps in a job are grouped together into a single job summary and are shown on the run summary page. If multiple jobs generate summaries, the job summaries are ordered by job completion time.
 .PARAMETER Value
 Content.
 .PARAMETER NoNewLine

hugoalh.GitHubActionsToolkit/module/utility.psm1

@@ -135,7 +135,7 @@ Function Test-Environment {
 		[Switch]$Artifact,
 		[Switch]$Cache,
 		[Alias('Oidc')][Switch]$OpenIdConnect,
-		[Alias('Summary')][Switch]$StepSummary,
+		[Switch]$StepSummary,
 		[Switch]$ToolCache,
 		[Alias('Force', 'Forced', 'Require', 'Required')][Switch]$Mandatory,
 		[Alias('RequiredMessage', 'RequireMessage')][String]$MandatoryMessage = 'This process require to execute inside the GitHub Actions environment!'