Skip to content

Get GitHubPullRequest

Howard Wolosky edited this page Oct 5, 2020 · 1 revision

Get-GitHubPullRequest

SYNOPSIS

Retrieve the pull requests in the specified repository.

SYNTAX

Elements (Default)

Get-GitHubPullRequest [-OwnerName <String>] [-RepositoryName <String>] [-PullRequest <Int64>] [-State <String>]
 [-Head <String>] [-Base <String>] [-Sort <String>] [-Direction <String>] [-AccessToken <String>]
 [<CommonParameters>]

Uri

Get-GitHubPullRequest -Uri <String> [-PullRequest <Int64>] [-State <String>] [-Head <String>] [-Base <String>]
 [-Sort <String>] [-Direction <String>] [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

Retrieve the pull requests in the specified repository.

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

EXAMPLES

EXAMPLE 1

$pullRequests = Get-GitHubPullRequest -Uri 'https://github.com/PowerShell/PowerShellForGitHub'

EXAMPLE 2

$pullRequests = Get-GitHubPullRequest -OwnerName microsoft -RepositoryName PowerShellForGitHub -State Closed

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

-Base

Base branch name to filter the pulls by.

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

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

-Direction

The direction to be used for Sort.

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

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

-Head

Filter pulls by head user and branch name in the format of 'user:ref-name'

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

Required: False
Position: Named
Default value: None
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: Elements
Aliases:

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

-PullRequest

The specific pull request id to return back. If not supplied, will return back all pull requests for the specified Repository.

Type: System.Int64
Parameter Sets: (All)
Aliases: PullRequestNumber

Required: False
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
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: Elements
Aliases:

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

-Sort

What to sort the results by.

  • created
  • updated
  • popularity (comment count)
  • long-running (age, filtering by pulls updated in the last month)
Type: System.String
Parameter Sets: (All)
Aliases:

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

-State

The state of the pull requests that should be returned back.

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

Required: False
Position: Named
Default value: Open
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: Uri
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.PulLRequest

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally