On this page

    Add-IssueToSprint

    SYNOPSIS

    Adds one or more Jira issues to a sprint.

    SYNTAX

    Add-IssueToSprint [-Issue] <Object> [-Sprint] <Sprint> [-Credential <PSCredential>] [<CommonParameters>]

    DESCRIPTION

    Add-IssueToSprint assigns Jira issues to a target sprint.

    If the supplied sprint object is incomplete, the command resolves it first and then submits issue keys in request batches.

    When imported normally, run this command as Add-JiraAgileIssueToSprint.

    EXAMPLES

    EXAMPLE 1

    $board  = JiraAgilePS\Get-Board -Credential $cred | Select-Object -First 1
$sprint = JiraAgilePS\Get-Sprint -Board $board -State Active -Credential $cred | Select-Object -First 1
$issue  = Get-JiraIssue -Issue "PROJ-123" -Credential $cred

JiraAgilePS\Add-IssueToSprint -Issue $issue -Sprint $sprint -Credential $cred

    Adds one Jira issue to the active sprint.

    EXAMPLE 2

    $issues = @(
    Get-JiraIssue -Issue "PROJ-123" -Credential $cred
    Get-JiraIssue -Issue "PROJ-124" -Credential $cred
)

JiraAgilePS\Add-IssueToSprint -Issue $issues -Sprint $sprint -Credential $cred

    Adds multiple issues to a sprint.

    EXAMPLE 3

    $issues | JiraAgilePS\Add-IssueToSprint -Sprint $sprint -Credential $cred

    Pipes issue objects directly into the command.

    PARAMETERS

    -Issue

    Issue object(s) to add to the sprint.

    Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

    -Sprint

    Target sprint object.

    Type: Sprint
Parameter Sets: (All)
Aliases:

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

    -Credential

    Credentials used for Jira authentication.

    Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

    CommonParameters

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

    INPUTS

    System.Object

    Issue object(s) from JiraPS commands, for example Get-JiraIssue.

    OUTPUTS

    System.Void

    NOTES

    This command does not emit output on success.

    Use Add-JiraAgileIssueToSprint in normal module usage. Add-IssueToSprint is the source function name.

    Get-Board

    Get-Sprint