Checkpoint GitHubIssue

---

external help file: XpandPosh.Cmdlets.dll-Help.xml Module Name: XpandPosh online version: schema: 2.0.0

Checkpoint-GitHubIssue

SYNOPSIS

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

SYNTAX

Checkpoint-GitHubIssue -Message <String> -CommitIssues <ICommitIssues[]> -Owner <String> -Organization <String>
 -Pass <String> [-ActivityId <Int32>] [-ActivityName <String>] [-ActivityStatus <String>]
 [-CompletionMessage <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

Similar code is used in Azure pipelines of the eXpandFramework for notifying an issued about related changes (nightly) in another branch or repository.

https://github.com/eXpandFramework/Azure-Tasks/blob/dd68f11ed64ee9e47ed85050b5ab8e2bc74c2287/Scripts/Checkpoint-GitHubIssue.ps1#L33

PARAMETERS

-ActivityId

{{ Fill ActivityId Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ActivityName

{{ Fill ActivityName Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-ActivityStatus

{{ Fill ActivityStatus Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-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

-CompletionMessage

{{ Fill CompletionMessage Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
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: (All)
Aliases:

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

-Pass

{{ Fill Pass Description }}

Type: String
Parameter Sets: (All)
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