api_function_addgithubactionssummarylink

Add-GitHubActionsSummaryLink

Important

Do not confused with functions:

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

• Type: Function
• In Version: >= v0.5.0
• Alias:
  • Add-GitHubActionsSummaryHyperlink

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

Important

Not support reference link!

• Add-GitHubActionsSummaryLink
    [-Text] <String>
    [-Uri] <String>
    [-Title <String>]
    [-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: False ❌

Text

<String> Text of the link.

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

Title

[Optional] <String> Title of the link.

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

Uri

<String> URI of the link.

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

Output

<Void>