Get GitHubPullRequest - X-Guardian/PowerShellForGitHub GitHub Wiki
Retrieve the pull requests in the specified repository.
Get-GitHubPullRequest [-OwnerName <String>] [-RepositoryName <String>] [-PullRequest <Int64>] [-State <String>]
[-Head <String>] [-Base <String>] [-Sort <String>] [-Direction <String>] [-AccessToken <String>] [-NoStatus]
[-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubPullRequest -Uri <String> [-PullRequest <Int64>] [-State <String>] [-Head <String>] [-Base <String>]
[-Sort <String>] [-Direction <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Retrieve the pull requests in the specified repository.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
$pullRequests = Get-GitHubPullRequest -Uri 'https://github.com/PowerShell/PowerShellForGitHub'
$pullRequests = Get-GitHubPullRequest -OwnerName microsoft -RepositoryName PowerShellForGitHub -State Closed
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: FalseBase 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: FalseThe 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: FalseFilter 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: FalseIf 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.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseOwner 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: FalseThe 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: FalseName 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: FalseWhat 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: FalseThe 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: FalseUri 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: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.