api_function_addgithubactionssummary

Add-GitHubActionsSummary

Important

Do not confused with functions:

• Add-GitHubActionsSummaryHeader
• Add-GitHubActionsSummaryImage
• Add-GitHubActionsSummaryLink
• Add-GitHubActionsSummarySubscriptText
• Add-GitHubActionsSummarySuperscriptText
• Set-GitHubActionsSummary

• Type: Function
• In Version: >= v2.0.0
• Alias:
  • Add-GitHubActionsSummaryRaw

Add some GitHub flavored Markdown for the current step to 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 finished, 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.

• Add-GitHubActionsSummary
    [-Value] <Object[]>
    [-NoNewLine]

Parameter

NoNewLine

[Optional] <Switch> Whether to 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.

• Position: Named
• Accept Pipeline Input By Property Name: True ✔️

Value

<String[]> Contents of the summary.

• Position: 0
• Accept Pipeline Input: True ✔️
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Content

Output

<Void>