Set-GitHubStepSummary¶
SYNOPSIS¶
Set a summary for the step in GitHub Actions
SYNTAX¶
Set-GitHubStepSummary [-Summary] <String> [-Overwrite] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
You can set some custom Markdown for each job so that it will be displayed on the summary page of a workflow run. You can use job summaries to display and group unique content, such as test result summaries, so that someone viewing the result of a workflow run doesn't need to go into the logs to see important information related to the run, such as failures.
Job summaries support GitHub flavored Markdown, and you can add your Markdown content for a step to the GITHUB_STEP_SUMMARY
environment file.
GITHUB_STEP_SUMMARY is unique for each step in a job.
For more information about the per-step file that
GITHUB_STEP_SUMMARY references, see Environment files.
When a job finishes, the summaries for all steps in a job are grouped together into a single job summary and are shown on the workflow run summary page. If multiple jobs generate summaries, the job summaries are ordered by job completion time.
EXAMPLES¶
EXAMPLE 1¶
Set-GitHubStepSummary -Summary 'Hello, World!'
PARAMETERS¶
-Summary¶
Summary of the step
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Overwrite¶
Whether to overwrite the existing summary
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.