api_function_writegithubactionsannotation

Write-GitHubActionsAnnotation

👎 Deprecated

This is officially deprecated, maybe throw warning in the latest version, and maybe remove in the future version.

• Type: Function
• In Version: v0.3.0 ~ v1.7.X

Prints an annotation message to the log.

• Write-GitHubActionsAnnotation
    [-Type] <Enum:GitHubActionsAnnotationType>
    [-Message] <String>
    [-File <String>] 
    [-Line <UInt32>]
    [-Column <UInt32>]
    [-EndLine <UInt32>]
    [-EndColumn <UInt32>]
    [-Title <String>]

Parameter

Column

[Optional] <UInt32> Column start of the issue file of the annotation.

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Alias:
  • Col
  • ColStart
  • ColumnStart
  • StartCol
  • StartColumn

EndColumn

[Optional] <UInt32> Column end of the issue file of the annotation.

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Alias:
  • ColEnd
  • ColumnEnd
  • EndCol

EndLine

[Optional] <UInt32> Line end of the issue file of the annotation.

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Alias:
  • LineEnd

File

[Optional] <String> Path of the issue file of the annotation.

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

Line

[Optional] <UInt32> Line start of the issue file of the annotation.

• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Alias:
  • LineStart
  • StartLine

Message

<String> Message of the annotation.

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

Title

[Optional] <String> Title of the annotation.

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

Type

<Enum:GitHubActionsAnnotationType> Type of the annotation.

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

Output

<Void>