< Back
Update-GitHubLabel
Post
NAME Update-GitHubLabel
SYNOPSIS
Updates an existing label on a given GitHub repository.
SYNTAX
Update-GitHubLabel [-OwnerName <String>] [-RepositoryName <String>] -Name <String> -NewName <String> -Color
<String> [-Description <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Update-GitHubLabel -Uri <String> -Name <String> -NewName <String> -Color <String> [-Description <String>]
[-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing label on a given GitHub repository.
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
-Name <String>
Current name of the label to be updated.
Emoji and codes are supported. For more information, see here:
https://www.webpagefx.com/tools/emoji-cheat-sheet/
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NewName <String>
New name for the label being updated.
Emoji and codes are supported. For more information, see here:
https://www.webpagefx.com/tools/emoji-cheat-sheet/
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Color <String>
Color (in HEX) for the new label, without the leading # sign.
Required? true
Position? named
Default value EEEEEE
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A short description of the label.
Required? false
Position? named
Default value
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Update-GitHubLabel -OwnerName Microsoft -RepositoryName PowerShellForGitHub -Name TestLabel -NewName
NewTestLabel -LabelColor BBBB00
Updates the existing label called TestLabel in the PowerShellForGitHub project to be called
'NewTestLabel' and be colored yellow.
RELATED LINKS
SYNOPSIS
Updates an existing label on a given GitHub repository.
SYNTAX
Update-GitHubLabel [-OwnerName <String>] [-RepositoryName <String>] -Name <String> -NewName <String> -Color
<String> [-Description <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Update-GitHubLabel -Uri <String> -Name <String> -NewName <String> -Color <String> [-Description <String>]
[-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing label on a given GitHub repository.
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
-Name <String>
Current name of the label to be updated.
Emoji and codes are supported. For more information, see here:
https://www.webpagefx.com/tools/emoji-cheat-sheet/
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NewName <String>
New name for the label being updated.
Emoji and codes are supported. For more information, see here:
https://www.webpagefx.com/tools/emoji-cheat-sheet/
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Color <String>
Color (in HEX) for the new label, without the leading # sign.
Required? true
Position? named
Default value EEEEEE
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A short description of the label.
Required? false
Position? named
Default value
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Update-GitHubLabel -OwnerName Microsoft -RepositoryName PowerShellForGitHub -Name TestLabel -NewName
NewTestLabel -LabelColor BBBB00
Updates the existing label called TestLabel in the PowerShellForGitHub project to be called
'NewTestLabel' and be colored yellow.
RELATED LINKS