Write-GitHubDebug¶
SYNOPSIS¶
Write a debug message in GitHub Actions
SYNTAX¶
Write-GitHubDebug [-Message] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
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: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.