api_function_writegithubactionsfail

Write-GitHubActionsFail

• Type: Function
• In Version: >= v0.3.0

Prints an error message to the log and end the process.

• Write-GitHubActionsFail
    [-Message] <String>
    [-File <String>]
    [-Line <UInt32>]
    [-Column <UInt32>]
    [-EndLine <UInt32>]
    [-EndColumn <UInt32>]
    [-Title <String>]
    [-Summary <String>]
    [-Finally <ScriptBlock>]
    [-ExitCode <Byte>]

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: False ❌
• 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: False ❌
• 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: False ❌
• Alias:
  • LineEnd

ExitCode

[Optional] <Byte> Exit code of the process.

• Default Value:

  1

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

File

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

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

Finally

[Optional] <ScriptBlock> A script block to invoke before end the process, use to free any resources that are no longer needed.

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

Line

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

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

Message

<String> Message that need to log at error level.

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

Summary

(>= v2.0.0) [Optional] <String> Summary of the message when it is too large to display.

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

Title

[Optional] <String> Title of the error message.

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

Output

<Void>