Skip to content

Close GithubIssue

Apostolis Bekiaris edited this page Apr 22, 2020 · 8 revisions

external help file: XpandPwsh.Cmdlets.dll-Help.xml Module Name: XpandPwsh online version: https://go.microsoft.com/fwlink/?LinkID=2097043 schema: 2.0.0

Close-GithubIssue

SYNOPSIS

Close a GitHub Issue based on its last update.

SYNTAX

Owner

Close-GithubIssue -Repository1 <String> [-Message <String>] [-DaysUntilClose <Int32>] [-KeepWhenAssignees]
 -Owner <String> -Organization <String> -Pass <String> [-WhatIf] [-Confirm] [<CommonParameters>]

Token

Close-GithubIssue -Repository1 <String> [-Message <String>] [-DaysUntilClose <Int32>] [-KeepWhenAssignees]
 -Organization <String> -Token <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Close a GitHub Issue based on its last update. The default value after which the issue can be close is 60 days.

EXAMPLES

Example 1

PS C:\> Close-GithubIssue -Repository1 eXpand -GitHubApp eXpandFramework -Owner $(GithubUserName) -Pass $(GithubPass) -Organization eXpandFramework

Closes all issues that are not updated the last 60 days for the eXpand repository.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-DaysUntilClose

The days after which the issue can be closes. Default is 60.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-KeepWhenAssignees

{{ Fill KeepWhenAssignees Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Message

A message to comment when closing the issue.

Type: String
Parameter Sets: (All)
Aliases:

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

-Organization

{{ Fill Organization Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Owner

{{ Fill Owner Description }}

Type: String
Parameter Sets: Owner
Aliases:

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

-Pass

{{ Fill Pass Description }}

Type: String
Parameter Sets: Owner
Aliases:

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

-Repository1

{{ Fill Repository1 Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Token

{{ Fill Token Description }}

Type: String
Parameter Sets: Token
Aliases:

Required: True
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: 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

None

OUTPUTS

Octokit.Issue

NOTES

RELATED LINKS

image

image


Star the project if you think it deserves it.

GitHub stars

Fork the project to extend and contribute.

GitHub forks

Clone this wiki locally