Get GitHubLabel

Get-GitHubLabel

SYNOPSIS

Retrieve label(s) of a given GitHub repository.

SYNTAX

NameUri (Default)

Get-GitHubLabel [-Label <String>] [-Issue <Int64>] [-MilestoneNumber <Int64>] [-AccessToken <String>]
 [<CommonParameters>]

Elements

Get-GitHubLabel -OwnerName <String> -RepositoryName <String> [-Label <String>] [-Issue <Int64>]
 [-MilestoneNumber <Int64>] [-AccessToken <String>] [<CommonParameters>]

Uri

Get-GitHubLabel -Uri <String> [-Label <String>] [-Issue <Int64>] [-MilestoneNumber <Int64>]
 [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

Retrieve label(s) of a given GitHub repository.

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

EXAMPLES

EXAMPLE 1

Get-GitHubLabel -OwnerName microsoft -RepositoryName PowerShellForGitHub

Gets the information for every label from the microsoft\PowerShellForGitHub project.

EXAMPLE 2

Get-GitHubLabel -OwnerName microsoft -RepositoryName PowerShellForGitHub -Label TestLabel

Gets the information for the label named "TestLabel" from the microsoft\PowerShellForGitHub project.

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

-Issue

If provided, will return all of the labels for this particular issue.

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

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

-Label

Name of the specific label to be retrieved. If not supplied, all labels will be retrieved. Emoji and codes are supported. For more information, see here: https://www.webpagefx.com/tools/emoji-cheat-sheet/

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

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

-MilestoneNumber

If provided, will return all of the labels assigned to issues for this particular milestone.

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

Required: False
Position: Named
Default value: 0
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: True
Position: Named
Default value: None
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: True
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.Label

NOTES

There were a lot of complications with the ParameterSets with this function due to pipeline input. For the time being, the ParameterSets have been simplified and the validation of parameter combinations is happening within the function itself.

RELATED LINKS