Skip to content

Get GitHubIssueComment

Howard Wolosky edited this page Oct 5, 2020 · 2 revisions

Get-GitHubIssueComment

SYNOPSIS

Get the Issue comments for a given GitHub repository.

SYNTAX

RepositoryElements (Default)

Get-GitHubIssueComment -OwnerName <String> -RepositoryName <String> [-Since <DateTime>] [-Sort <String>]
 [-Direction <String>] [-MediaType <String>] [-AccessToken <String>] [<CommonParameters>]

CommentElements

Get-GitHubIssueComment -OwnerName <String> -RepositoryName <String> -Comment <Int64> [-MediaType <String>]
 [-AccessToken <String>] [<CommonParameters>]

IssueElements

Get-GitHubIssueComment -OwnerName <String> -RepositoryName <String> -Issue <Int64> [-Since <DateTime>]
 [-MediaType <String>] [-AccessToken <String>] [<CommonParameters>]

CommentUri

Get-GitHubIssueComment -Uri <String> -Comment <Int64> [-MediaType <String>] [-AccessToken <String>]
 [<CommonParameters>]

IssueUri

Get-GitHubIssueComment -Uri <String> -Issue <Int64> [-Since <DateTime>] [-MediaType <String>]
 [-AccessToken <String>] [<CommonParameters>]

RepositoryUri

Get-GitHubIssueComment -Uri <String> [-Since <DateTime>] [-Sort <String>] [-Direction <String>]
 [-MediaType <String>] [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

Get the Issue comments for a given GitHub repository.

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

EXAMPLES

EXAMPLE 1

Get-GitHubIssueComment -OwnerName microsoft -RepositoryName PowerShellForGitHub

Get all of the Issue comments for the microsoft\PowerShellForGitHub project.

EXAMPLE 2

$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName PowerShellForGitHub
$repo | Get-GitHubIssueComment -Since ([DateTime]::Now).AddDays(-1)

Get all of the Issue comments for the microsoft\PowerShellForGitHub project since yesterday.

EXAMPLE 3

$issue = $repo | Get-GitHubIssueComment -OwnerName microsoft -RepositoryName PowerShellForGitHub -Issue 1

Get the comments Issue #1 in the microsoft\PowerShellForGitHub project.

EXAMPLE 4

$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName PowerShellForGitHub
$issue = $repo | Get-GitHubIssue -Issue 1
$issue | Get-GitHubIssueComment

Get the comments Issue #1 in the microsoft\PowerShellForGitHub project.

EXAMPLE 5

$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName PowerShellForGitHub
$issue = $repo | Get-GitHubIssue -Issue 1
$comments = $issue | Get-GitHubIssueComment
$comment[0] | Get-GitHubIssueComment

Get the most recent comment on Issue #1 in the microsoft\PowerShellForGitHub project by passing it in via the pipeline. This shows some of the different types of objects you can pipe into this function.

PARAMETERS

-AccessToken

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.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Comment

The ID of a specific comment to get. If not supplied, will return back all comments for this repository.

Type: System.Int64
Parameter Sets: CommentElements, CommentUri
Aliases: CommentId

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Direction

How to list the results. Ignored without the sort parameter.

Type: System.String
Parameter Sets: RepositoryElements, RepositoryUri
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Issue

Issue number to get comments for. If not supplied, will return back all comments for this repository.

Type: System.Int64
Parameter Sets: IssueElements, IssueUri
Aliases: IssueNumber

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MediaType

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.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Raw
Accept pipeline input: False
Accept wildcard characters: False

-OwnerName

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

Type: System.String
Parameter Sets: RepositoryElements, CommentElements, IssueElements
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RepositoryName

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

Type: System.String
Parameter Sets: RepositoryElements, CommentElements, IssueElements
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Since

Only comments updated at or after this time are returned.

Type: System.DateTime
Parameter Sets: RepositoryElements, IssueElements, IssueUri, RepositoryUri
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sort

How to sort the results.

Type: System.String
Parameter Sets: RepositoryElements, RepositoryUri
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Uri

Uri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.

Type: System.String
Parameter Sets: CommentUri, IssueUri, RepositoryUri
Aliases: RepositoryUrl

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.

INPUTS

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Reaction

GitHub.Release

GitHub.ReleaseAsset

GitHub.Repository

OUTPUTS

GitHub.IssueComment

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally