api_function_writegithubactionsdebug

Write-GitHubActionsDebug

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

Prints a debug message to the log.

• # >= v2.0.0; Parameter Set: PassThru
  Write-GitHubActionsDebug
    [-Message] <String>
    [-SkipEmptyMessage]
    -PassThru

• # >= v2.0.0; Parameter Set: Void
  Write-GitHubActionsDebug
    [-Message] <String>
    [-SkipEmptyMessage]

• # < v2.0.0
  Write-GitHubActionsDebug
    [-Message] <String>
    [-SkipEmptyLine]
    [-PassThru]

Parameter

Message

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

• Parameter Set: (>= v2.0.0)
  • PassThru
  • Void
• Position: 0
• Accept Pipeline Input: True ✔️
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Content

PassThru

• (>= v2.0.0) <Switch> Return the message. By default, this function does not generate any output.
• (< v2.0.0) [Optional] <Switch> Return the message. By default, this function does not generate any output.

•

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

SkipEmptyMessage

(>= v2.0.0) [Optional] <Switch> Whether to skip empty message.

• Parameter Set: (>= v2.0.0)
  • PassThru
  • Void
• Position: Named
• Accept Pipeline Input By Property Name: False ❌
• Alias:
  • SkipEmpty

SkipEmptyLine

👎 Deprecated

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

(< v2.0.0) [Optional] <Switch> Whether to skip empty line.

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

Output

• PassThru: <String> When use the parameter PassThru, this function return the message.
• Void: <Void> By default, this function does not generate any output.