< Back
Get-GitHubRepositoryContributor
Post
NAME Get-GitHubRepositoryContributor
SYNOPSIS
Retrieve list of contributors for a given repository.
SYNTAX
Get-GitHubRepositoryContributor [-OwnerName <String>] [-RepositoryName <String>] [-IncludeAnonymousContributors]
[-IncludeStatistics] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubRepositoryContributor -Uri <String> [-IncludeAnonymousContributors] [-IncludeStatistics] [-AccessToken
<String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Retrieve list of contributors for a given repository.
GitHub identifies contributors by author email address.
This groups contribution counts by GitHub user, which includes all associated email addresses.
To improve performance, only the first 500 author email addresses in the repository link to
GitHub users. The rest will appear as anonymous contributors without associated GitHub user
information.
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
-IncludeAnonymousContributors [<SwitchParameter>]
If specified, anonymous contributors will be included in the results.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IncludeStatistics [<SwitchParameter>]
If specified, each result will include statistics for the number of additions, deletions
and commit counts, by week (excluding merge commits and empty commits).
Required? false
Position? named
Default value False
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
[PSCustomObject[]] List of contributors for the repository.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-GitHubRepositoryContributor -OwnerName Microsoft -RepositoryName PowerShellForGitHub
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-GitHubRepositoryContributor -Uri 'https://github.com/PowerShell/PowerShellForGitHub' -IncludeStatistics
RELATED LINKS
SYNOPSIS
Retrieve list of contributors for a given repository.
SYNTAX
Get-GitHubRepositoryContributor [-OwnerName <String>] [-RepositoryName <String>] [-IncludeAnonymousContributors]
[-IncludeStatistics] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubRepositoryContributor -Uri <String> [-IncludeAnonymousContributors] [-IncludeStatistics] [-AccessToken
<String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Retrieve list of contributors for a given repository.
GitHub identifies contributors by author email address.
This groups contribution counts by GitHub user, which includes all associated email addresses.
To improve performance, only the first 500 author email addresses in the repository link to
GitHub users. The rest will appear as anonymous contributors without associated GitHub user
information.
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
-IncludeAnonymousContributors [<SwitchParameter>]
If specified, anonymous contributors will be included in the results.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IncludeStatistics [<SwitchParameter>]
If specified, each result will include statistics for the number of additions, deletions
and commit counts, by week (excluding merge commits and empty commits).
Required? false
Position? named
Default value False
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
[PSCustomObject[]] List of contributors for the repository.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-GitHubRepositoryContributor -OwnerName Microsoft -RepositoryName PowerShellForGitHub
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-GitHubRepositoryContributor -Uri 'https://github.com/PowerShell/PowerShellForGitHub' -IncludeStatistics
RELATED LINKS