api_function_writegithubactionsfail

Write-GitHubActionsFail

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

Description

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

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

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

(>= v1.5.0) [Optional] <Int32> Exit code of the process.

• 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

(>= v1.5.0) [Optional] <ScriptBlock> A script that execute 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

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>