Checkpoint GitHubIssue

---

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

Checkpoint-GitHubIssue

SYNOPSIS

Adds unique comments to a GitHub issue containing template info from related commits.

SYNTAX

Owner

Checkpoint-GitHubIssue -Message <String> -CommitIssues <ICommitIssues[]> -Owner <String> -Organization <String>
 -Pass <String> [-WhatIf] [-Confirm] [<CommonParameters>]

Token

Checkpoint-GitHubIssue -Message <String> -CommitIssues <ICommitIssues[]> -Organization <String> -Token <String>
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This function will create a unique comment to all issues of the CommitIssues parameter. The comment will contain all commits for the issue and a template can be applied.

EXAMPLES

Example 1

$commitIssues = Get-GitHubCommitIssue @commitIssueArgs 
$msg = "The repository includes commit {Commits} that relate to this issue."
Checkpoint-GithubIssue -CommitIssues $commitIssues -Message $msg @cred

Notifying an issue about related changes (nightly) in another branch or repository.

PARAMETERS

-CommitIssues

This array can be obtained from the Get-GitHubCommitIssues cmdlet

Type: ICommitIssues[]
Parameter Sets: (All)
Aliases:

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

-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

-Message

The Message that will be used as a template. Included {Commits} to position the related commits in the template.

Type: String
Parameter Sets: (All)
Aliases:

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

-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

System.Object

NOTES

RELATED LINKS