Write-GitHubDebug

SYNOPSIS

Write a debug message in GitHub Actions

SYNTAX

__AllParameterSets

Write-GitHubDebug [-Message] <string> [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Write a debug message in GitHub Actions. The message will only be displayed if the action is running in debug mode. To run in debug mode, you must create a secret or variable named ACTIONS_STEP_DEBUG with the value true to see the debug messages set by this command in the log. For more information, see Enabling debug logging.

If both the secret and variable are set, the value of the secret takes precedence over the variable.

EXAMPLES

EXAMPLE 1

Write-GitHubDebug -Message 'Hello, World!'

Writes a debug message 'Hello, World!'.

PARAMETERS

-Message

Message to write

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Void

{{ Fill in the Description }}

NOTES

Enabling debug logging

RELATED LINKS