Get GitHubLabel - X-Guardian/PowerShellForGitHub GitHub Wiki
Retrieve label(s) of a given GitHub repository.
Get-GitHubLabel [-Label <String>] [-Issue <Int64>] [-MilestoneNumber <Int64>] [-AccessToken <String>]
[-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubLabel -OwnerName <String> -RepositoryName <String> [-Label <String>] [-Issue <Int64>]
[-MilestoneNumber <Int64>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubLabel -Uri <String> [-Label <String>] [-Issue <Int64>] [-MilestoneNumber <Int64>]
[-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Retrieve label(s) of a given GitHub repository.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
Get-GitHubLabel -OwnerName microsoft -RepositoryName PowerShellForGitHub
Gets the information for every label from the microsoft\PowerShellForGitHub project.
Get-GitHubLabel -OwnerName microsoft -RepositoryName PowerShellForGitHub -Label TestLabel
Gets the information for the label named "TestLabel" from the microsoft\PowerShellForGitHub project.
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
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
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
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
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.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
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
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 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
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
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.