Versions Compared

Old Version 6

changes.mady.by.user Bogdan Visan (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Jonathan Muse

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleAvailability

This routine is available starting with Power Scripts 4.6.0.

Syntax

updateSprint(sprintId, sprintName)

...

updateSprint(sprintId, sprintName, state, startDate, endDate, completionDate)

Description

Excerpt

Updates a given sprint.

Parameters

Parameter name

Type

Required

Description

sprintId

number

Yes

The sprint id.

sprintNamestringYes

The new name of the sprint.

Note

By leaving the name empty the name already defined will not be modfied.


statestringYes

The state of the sprint.

Note

There are 3 states of the sprint: 'feature', 'active' and 'closed'.


startDatedateYes

The start date of the sprint.

Note

By leaving the date empty the start date already defined will not be modified.


endDatedateYes

The end date of the sprint.

Note

By leaving the date empty the end date already defined will not be modified.


completionDatedate
The completion date of the sprint.

...

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
umbernumber 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);

...