Functions/Public/New-GitHubComment.ps1
|
function New-GitHubComment { <# .SYNOPSIS Creates a comment on a GitHub issue. .PARAMETER Owner The GitHub username of the account or organization that owns the GitHub repository specified in the -RepositoryName parameter. .PARAMETER Repository The name of the GitHub repository containing the issue to which the comment will be added. .PARAMETER Number The number of the issue to which the comment will be added. .PARAMETER Body The text of the comment. .EXAMPLE # Add a multiline comment containing Markdown to an issue: $body = @" Things to consider: - A thing - Another thing "@ New-GitHubComment -Owner Mary -RepositoryName WebApps -Number 42 -Body $body #> [CmdletBinding()] param ( [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('User')] [string] $Owner, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [ValidatePattern('^[\w-\.]+$')] [string] $RepositoryName, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [ValidateRange(1, [int]::MaxValue)] [int] $Number, [Parameter(Mandatory)] [string] $Body, # Optional base URL of the GitHub API, for example "https://ghe.mycompany.com/api/v3/" (including the trailing slash). # Defaults to "https://api.github.com" [Uri] $BaseUri = [Uri]::new('https://api.github.com'), [Security.SecureString] $Token = (Get-GitHubToken) ) $uri = 'repos/{0}/{1}/issues/{2}/comments' -f $Owner, $RepositoryName, $Number $apiBody = @{ body = $Body } | ConvertTo-Json $apiCall = @{ Method = 'Post'; Uri = $uri; Body = $apiBody; Token = $Token BaseUri = $BaseUri } Invoke-GitHubApi @apiCall | ForEach-Object { $_.PSTypeNames.Insert(0, 'PSGitHub.Comment') $_.User.PSTypeNames.Insert(0, 'PSGitHub.User') $_ } } |