Set GitHubReaction

Set-GitHubReaction

SYNOPSIS

Sets a reaction of a given GitHub Issue or Pull Request.

SYNTAX

ElementsIssue (Default)

Set-GitHubReaction -OwnerName <String> -RepositoryName <String> -Issue <Int64> -ReactionType <String>
 [-PassThru] [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

ElementsPullRequest

Set-GitHubReaction -OwnerName <String> -RepositoryName <String> -PullRequest <Int64> -ReactionType <String>
 [-PassThru] [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

UriPullRequest

Set-GitHubReaction -Uri <String> -PullRequest <Int64> -ReactionType <String> [-PassThru]
 [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

UriIssue

Set-GitHubReaction -Uri <String> -Issue <Int64> -ReactionType <String> [-PassThru] [-AccessToken <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets a reaction of a given GitHub Issue or Pull Request.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Set-GitHubReaction -OwnerName PowerShell -RepositoryName PowerShell -Issue 12626 -ReactionType rocket

Sets the 'rocket' reaction for issue 12626 of the PowerShell\PowerShell project.

EXAMPLE 2

Get-GitHubPullRequest -Uri https://github.com/microsoft/PowerShellForGitHub -PullRequest 193 | Set-GitHubReaction -ReactionType Heart

Gets a GitHub pull request and pipes it into Set-GitHubReaction to set the 'heart' reaction for that pull request.

PARAMETERS

-AccessToken

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

-Issue

The issue number.

Type: System.Int64
Parameter Sets: ElementsIssue, UriIssue
Aliases: IssueNumber

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OwnerName

Owner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.

Type: System.String
Parameter Sets: ElementsIssue, ElementsPullRequest
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Returns the updated Reaction. By default, this cmdlet does not generate any output. You can use "Set-GitHubConfiguration -DefaultPassThru" to control the default behavior of this switch.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PullRequest

The pull request number.

Type: System.Int64
Parameter Sets: ElementsPullRequest, UriPullRequest
Aliases: PullRequestNumber

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ReactionType

The type of reaction you want to set. This is aslo called the 'content' in the GitHub API. Valid options are based off: https://developer.github.com/v3/reactions/#reaction-types

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RepositoryName

Name of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.

Type: System.String
Parameter Sets: ElementsIssue, ElementsPullRequest
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Uri

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: UriPullRequest, UriIssue
Aliases: RepositoryUrl

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

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

-WhatIf

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Reaction

GitHub.Release

GitHub.Repository

OUTPUTS

GitHub.Reaction

NOTES

Currently, issue comments, pull request comments and commit comments are not supported.

RELATED LINKS