Group GitHubPullRequest - X-Guardian/PowerShellForGitHub GitHub Wiki

Group-GitHubPullRequest

SYNOPSIS

Groups the provided pull requests based on the specified grouping criteria.

SYNTAX

Group-GitHubPullRequest -PullRequest <PSObject[]> -Weeks <Int32> [-DateType <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Groups the provided pull requests based on the specified grouping criteria.

Currently able to group Pull Requests by week.

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

EXAMPLES

EXAMPLE 1

$pullRequests = @()

$pullRequests += Get-GitHubPullRequest -Uri 'https://github.com/powershell/xpsdesiredstateconfiguration' $pullRequests += Get-GitHubPullRequest -Uri 'https://github.com/powershell/xactivedirectory' $pullRequests | Group-GitHubPullRequest -Weeks 12 -DateType Closed

PARAMETERS

-DateType

The date property that should be inspected when determining which week grouping the pull request if part of.

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

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

-PullRequest

The Pull Requests(s) to be grouped.

Type: System.Management.Automation.PSObject[]
Parameter Sets: (All)
Aliases:

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

-Weeks

The number of weeks to group the Pull Requests by.

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

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

-Confirm

Prompts 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: False

-WhatIf

Shows 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: 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.PullRequest

OUTPUTS

[PSCustomObject[]] Collection of pull requests and counts, by week, along with the

total count of pull requests.

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️