< Back
Set-GitHubMilestone
Post
NAME Set-GitHubMilestone
SYNOPSIS
SYNTAX
Set-GitHubMilestone -OwnerName <String> -RepositoryName <String> -Milestone <Int64> -Title <String> [-State
<String>] [-Description <String>] [-DueOn <DateTime>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-GitHubMilestone -Uri <String> -Milestone <Int64> -Title <String> [-State <String>] [-Description <String>]
[-DueOn <DateTime>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Update an existing milestone for the given 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? true
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? true
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
-Milestone <Int64>
The number of a specific milestone to get.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Title <String>
The title of the milestone.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-State <String>
The state of the milestone.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A description of the milestone.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DueOn <DateTime>
The milestone due date.
GitHub will drop any time provided with this value, therefore please ensure that the
UTC version of this value has your desired date.
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
NOTES
For more information on how GitHub handles the dates specified in DueOn, please refer to
this support forum post:
https://github.community/t5/How-to-use- ... 00-when-se
t-by-v3/m-p/6901
Please note that due to artifacts of how GitHub was originally designed, all timestamps
in the GitHub database are normalized to Pacific Time. This means that any dates specified
that occur before 7am UTC will be considered timestamps for the _previous_ day.
Given that GitHub drops the _time_ aspect of this DateTime, this function will ensure that
the requested DueOn date specified is honored by manipulating the time as needed.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-GitHubMilestone -OwnerName Microsoft -RepositoryName PowerShellForGitHub -Milestone 1 -Title "Testing
this API"
Update an existing milestone for the Microsoft\\PowerShellForGitHub project.
RELATED LINKS
SYNOPSIS
SYNTAX
Set-GitHubMilestone -OwnerName <String> -RepositoryName <String> -Milestone <Int64> -Title <String> [-State
<String>] [-Description <String>] [-DueOn <DateTime>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-GitHubMilestone -Uri <String> -Milestone <Int64> -Title <String> [-State <String>] [-Description <String>]
[-DueOn <DateTime>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Update an existing milestone for the given 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? true
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? true
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
-Milestone <Int64>
The number of a specific milestone to get.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Title <String>
The title of the milestone.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-State <String>
The state of the milestone.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A description of the milestone.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DueOn <DateTime>
The milestone due date.
GitHub will drop any time provided with this value, therefore please ensure that the
UTC version of this value has your desired date.
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
NOTES
For more information on how GitHub handles the dates specified in DueOn, please refer to
this support forum post:
https://github.community/t5/How-to-use- ... 00-when-se
t-by-v3/m-p/6901
Please note that due to artifacts of how GitHub was originally designed, all timestamps
in the GitHub database are normalized to Pacific Time. This means that any dates specified
that occur before 7am UTC will be considered timestamps for the _previous_ day.
Given that GitHub drops the _time_ aspect of this DateTime, this function will ensure that
the requested DueOn date specified is honored by manipulating the time as needed.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-GitHubMilestone -OwnerName Microsoft -RepositoryName PowerShellForGitHub -Milestone 1 -Title "Testing
this API"
Update an existing milestone for the Microsoft\\PowerShellForGitHub project.
RELATED LINKS