The use of this routine requires the Power Scripts for Jira add-on be installed and licensed.
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | updateSprint(sprintId, sprintName) | Package | | Alias | | Pkg Usage | | |
Description
| Excerpt |
|---|
|
| Updates a given sprint. |
Updates a given sprint.
Parameters
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
Parameter name | Type | Required | Description |
|---|
sprintId | Number | Yes | The sprint id. | sprintName | String | Yes | The new name of the sprint. By leaving the name empty the name already defined will not be modfied. | state | String | Yes | The state of the sprint. There are 3 states of the sprint: 'feature', 'active' and 'closed'. | startDate | Date | Yes | The start date of the sprint. By leaving the date empty the start date already defined will not be modified. | endDate | Date | Yes | The end date of the sprint. By leaving the date empty the end date already defined will not be modified. | completionDate | Date | No | The completion date of the sprint. | |
Return Type
Boolean
Returns true if the sprint was successfully updated.
Examples
Example 1
| Code Block |
|---|
number newSprintId = createSprint(1, "Sprint");
string nameOfNewSprint = sprintName(newSprintId);
runnerLog("The sprint was created with the id "+newSprintId+" and the name "+nameOfNewSprint);
updateSprint(newSprintId, "UpdatedSprintName");
string nameOfUpdatedSprint = sprintName(newSprintId);
runnerLog("The sprint was created with the id "+newSprintId+" and the name "+nameOfUpdatedSprint); |
Example 2
| Code Block |
|---|
number newSprintId = createSprint(1, "Sprint"); // it's in future state initially
addIssueToSprint("AGILE-1", newSprintId);
updateSprint(newSprintId, "", "active", "06/Apr/19 10:00 AM", "20/Apr/19 08:00 AM"); //the sprint is planned and started
string nameOfUpdatedSprint = sprintName(newSprintId);
date startDate = sprintStartDate(newSprintId);
date endDate = sprintEndDate(newSprintId);
runnerLog("The sprint" + nameOfUpdatedSprint + "was created and planned!); // the name remains "Sprint"
runnerLog("It starts on " + startDate + " and ends on " + endDate); |
Example 3
| Code Block |
|---|
number newSprintId = createSprint(1, "Sprint", "06/Apr/19 10:00 AM", "20/Apr/19 08:00 AM"); // it's in active state
addIssueToSprint("AGILE-1", newSprintId);
updateSprint(newSprintId, "", "closed", "", "","20/Apr/19"); // Spring was completed on 20/Apr/19
date completiontDate = sprintCompleteDate(newSprintId);
runnerLog("Sprint was completed on " + completionDate); |
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 25 |
|---|
| showSpace | false |
|---|
| cql | label = "agile_routine" and space = currentSpace ( ) |
|---|
| labels | array_routines |
|---|
|
We've encountered an issue exporting this macro. Please try exporting this page again later.