api_function_addgithubactionssummaryimage

Add-GitHubActionsSummaryImage

Important

Do not confused with functions:

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

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

Add image for the current step to display on the summary page of a run.

Important

Not support reference image!

• Add-GitHubActionsSummaryImage
    [-Uri] <String>
    [-Title <String>]
    [-AlternativeText <String>]
    [-Width <Int32>]
    [-Height <Int32>]
    [-NoNewLine]

Parameter

AlternativeText

[Optional] <String> Alternative text of the image.

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌
• Accept Wildcard Characters: False ❌
• Alias:
  • Alt
  • AltText

Height

[Optional] <Int32> Height of the image, by pixels (px).

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌

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: False ❌

Title

[Optional] <String> Title of the image.

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌
• Accept Wildcard Characters: False ❌

Uri

<String> URI of the image.

• Position: 0
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌
• Accept Wildcard Characters: False ❌
• Alias:
  • Url

Width

[Optional] <Int32> Width of the image, by pixels (px).

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: False ❌

Output

<Void>