Set-GitHubComment

NAME Set-GitHubComment



SYNOPSIS





SYNTAX

Set-GitHubComment [-OwnerName <String>] [-RepositoryName <String>] -CommentID <String> -Body <String> [-MediaType

<String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]



Set-GitHubComment -Uri <String> -CommentID <String> -Body <String> [-MediaType <String>] [-AccessToken <String>]

[-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Set an existing comment in an issue for the given repository



The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub





PARAMETERS

-OwnerName <String>

Owner of the repository.

If not supplied here, the DefaultOwnerName configuration property value will be used.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RepositoryName <String>

Name of the repository.

If not supplied here, the DefaultRepositoryName configuration property value will be used.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Uri <String>

Uri for the repository.

The OwnerName and RepositoryName will be extracted from here instead of needing to provide

them individually.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CommentID <String>

The comment ID of the comment to edit.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Body <String>

The new contents of the comment.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MediaType <String>

The format in which the API will return the body of the comment.



Raw - Return the raw markdown body. Response will include body. This is the default if you do not pass any

specific media type.

Text - Return a text only representation of the markdown body. Response will include body_text.

Html - Return HTML rendered from the body's markdown. Response will include body_html.

Full - Return raw, text and HTML representations. Response will include body, body_text, and body_html.



Required? false

Position? named

Default value Raw

Accept pipeline input? false

Accept wildcard characters? false



-AccessToken <String>

If provided, this will be used as the AccessToken for authentication with the

REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-NoStatus [<SwitchParameter>]

If this switch is specified, long-running commands will run on the main thread

with no commandline status update. When not specified, those commands run in

the background, enabling the command prompt to provide status information.

If not supplied here, the DefaultNoStatus configuration property value will be used.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Set-GitHubComment -OwnerName Microsoft -RepositoryName PowerShellForGitHub -CommentID 1 -Body "Testing this

API"



Update an existing comment in an issue for the Microsoft\\PowerShellForGitHub project.











RELATED LINKS