Functions/Public/Set-GitHubIssue.ps1
|
function Set-GitHubIssue { <# .Synopsis Creates a new GitHub issue. .Parameter Title Required. The title of the new GitHub issue that will be created. This field doesn't support Markdown. .Parameter Body Optional. Defines the body text, using Markdown, for the GitHub issue. Most people probably won't like you if you don't specify a body, so the recommendation would be to specify one. .Parameter Owner The GitHub username of the account or organization that owns the GitHub repository specified in the -Repository parameter. .Parameter Repository Required. The name of the GitHub repository that is owned by the -Owner parameter, where the new GitHub issue will be created. .Parameter Assignee Optional. The GitHub username of the individual who the new issues will be assigned to. .Parameter Labels Optional. An array of strings that indicate the labels that will be assigned to this GitHub issue upon creation. .Parameter Milestone The number of the milestone that the issue will be assigned to. Use Get-GitHubMilestone to retrieve a list of milestones. .Parameter State Optional. The state to which the issue will be set ('open' or 'closed'). .Parameter Number The GitHub issue number, in the specified GitHub repository, that will be updated. .Link https://trevorsullivan.net https://developer.github.com/v3/issues #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [Alias('User')] [string] $Owner, [Parameter(Mandatory = $true)] [string] $Repository, [Parameter(Mandatory = $true)] [string] $Title, [Parameter(Mandatory = $true)] [string] $Number, [Parameter(Mandatory = $false)] [string] $Body, [Parameter(Mandatory = $false)] [string] $Assignee, [Parameter(Mandatory = $false)] [string[]] $Labels, [Parameter(Mandatory = $false)] [string] $Milestone, [Parameter(Mandatory = $false)] [ValidateSet('open', 'closed')] [string] $State, [Security.SecureString] $Token = (Get-GitHubToken) ) ### Build the core message body -- we'll add more properties soon $ApiBody = @{ }; ### Add the updated title, to the message payload if ($Title) { $ApiBody.Add('title', $Title); } ### Add an issue body to the message payload (optional) if ($Body) { $ApiBody.Add('body', $Body); } ### TODO: Validate that this assignee is valid for this specific repository, before attempting to assign them. ### Use the Test-GitHubAssignee command for this. if ($Assignee) { $ApiBody.Add('assignee', $Assignee); } ### Add array of labels to the issue message body if ($Labels) { $ApiBody.Add('labels', $Labels); } ### Add the milestone to the issue message body if ($Milestone) { $ApiBody.Add('milestone', $Milestone); } ### Add the state to the issue message body. if ($State) { $ApiBody.Add('state', $State); } ### Set up the API call $ApiCall = @{ Body = $ApiBody | ConvertTo-Json Uri = 'repos/{0}/{1}/issues/{2}' -f $Owner, $Repository, $Number; Method = 'Patch'; Token = $Token } ### Invoke the GitHub REST method Invoke-GitHubApi @ApiCall; } |