Skip to content

Get GitHubRepositoryBranch

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

Get-GitHubRepositoryBranch

SYNOPSIS

Retrieve branches for a given GitHub repository.

SYNTAX

Elements (Default)

Get-GitHubRepositoryBranch [-OwnerName <String>] [-RepositoryName <String>] [-BranchName <String>]
 [-ProtectedOnly] [-AccessToken <String>] [<CommonParameters>]

Uri

Get-GitHubRepositoryBranch -Uri <String> [-BranchName <String>] [-ProtectedOnly] [-AccessToken <String>]
 [<CommonParameters>]

DESCRIPTION

Retrieve branches for a given GitHub repository.

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

EXAMPLES

EXAMPLE 1

Get-GitHubRepositoryBranch -OwnerName microsoft -RepositoryName PowerShellForGitHub

Gets all branches for the specified repository.

EXAMPLE 2

$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName PowerShellForGitHub
$repo | Get-GitHubRepositoryBranch

Gets all branches for the specified repository.

EXAMPLE 3

Get-GitHubRepositoryBranch -Uri 'https://github.com/PowerShell/PowerShellForGitHub' -BranchName master

Gets information only on the master branch for the specified repository.

EXAMPLE 4

$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName PowerShellForGitHub
$repo | Get-GitHubRepositoryBranch -BranchName master

Gets information only on the master branch for the specified repository.

EXAMPLE 5

$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName PowerShellForGitHub
$branch = $repo | Get-GitHubRepositoryBranch -BranchName master
$branch | Get-GitHubRepositoryBranch

Gets information only on the master branch for the specified repository, and then does it again. This tries to show 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

-BranchName

{{ Fill BranchName Description }}

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

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

-ProtectedOnly

{{ Fill ProtectedOnly Description }}

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

List of branches within the given repository.

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally