Write-GitHubNotice¶
SYNOPSIS¶
Write a notice message in GitHub Actions
SYNTAX¶
Write-GitHubNotice [-Message] <String> [[-Name] <String>] [[-Line] <Int32>] [[-Column] <Int32>]
[[-EndColumn] <Int32>] [[-EndLine] <Int32>] [[-Title] <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
Write a notice message in GitHub Actions. The message will be displayed in the GitHub Actions log.
EXAMPLES¶
EXAMPLE 1¶
Write-GitHubNotice -Message 'Hello, World!'
Writes a notice 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
-Name¶
The name of the file that this notice is related to
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Line¶
The line number that this notice is related to
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Column¶
The column number that this notice is related to
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-EndColumn¶
The end column number that this notice is related to
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-EndLine¶
The end line number that this notice is related to
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Title¶
The title of the notice
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
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.