Stories (3)

• Support for sprint variables 🎁

  Background

  Many teams don’t use versions in Jira, instead, they use sprints in Jira. Some also use sprints along with versions in Jira to manage their projects. In ARN we mainly support versions and version variables to generate release notes. Hence, we need to provide support for sprint variables like version variables in ARN.

  User Story

  As a user I want to insert sprint variables in my ARN templates so that I can publish release notes for the sprints created in my Jira project(s).

  Description

  Addition of Sprint Variables in Variables

  • In all types of templates, we can add various types of variables. We will include following sprint variables in that list :

  • As the no. of variables in the select menu have increased, we will convert this select menu into ‘Grouped Select Menu’

  ( Refer: https://atlassian.design/components/select/examples#grouped-options ) like this

  • Variables shall be grouped like this:

  • System shall replace the sprint variables with the actual value for a sprint which user shall select on the sprint selector screen. (similar to the way value of version variables is replaced in template preview currently)

  Sprint variables in the JQL

  Just like version variables, users can use multiple sprint variables in the JQL.

  project = "11915" and Sprint = ""

  project = "11915" and Sprint in ("","")

  • Sprint variables used in the JQL like this shall be accepted in the JQL validation.

  • Users can also use sprintName variable instead of the sprintId variable and system shall recognize the sprint just like versionName variable is honored instead of versionId variable in the JQL.

  project ="11915" and sprint in ("","")

  Version Selector screen - in-project

  • Currently when version variables are used in the template or the JQL , then on version selector screen, system asks the user to select corresponding versions for each of the version variables used in the template.

  • Same way when users have included sprint variables in the template or the JQL, then on version selector screen, system shall also ask the user to select corresponding sprint along with the version.

  Refer:

  • No of sprint selectors shown on version selector screen shall depend upon no of unique sprint variables used in the template.

  • Similar to versions, selecting sprint on version selector screen shall be optional.

  • System shall show all the sprints available in the project in sprint selector irrespective of their state.( 'future', 'active', 'closed' )

  • If the template has no version variables but only sprint variables, then on version selector screen only sprint select menus shall be shown.

  • Change in message shown on version selector screen

    • In case of multiple versions, we show the message on version selector screen. This message shall be changed to a generalized version like this.

      • When multiple version and sprint variables are used

  MULTIPLE VARIABLES USED

  This template uses multiple variables, please select values for each one.

  • When no version or sprint variable is used.

  NO VARIABLES USED

  This template does not use any variables, thus no inputs needed from you.

  Version Selector screen - cross-project

  • In case of cross project version selector screen, user has to select the project before selecting the version variable.

  • Similar to this, system shall ask user to select the sprint below the corresponding project selector.

  • few examples

    • when there are two version variables and two sprint variables included in the template

  •  

    • when there is one version variable and two sprint variables included in the template

  •  

    • when there is no version variable and two sprint variables included in the template

  • Change in message shown on version selector screen

    • In case of cross project, we show the message on version selector screen. This message shall be changed to a generalized version like this.

  TEMPLATE WITH CROSS PROJECT MULTIPLE VARIABLES

  Template involves use of multiple variables. Please select a project & corresponding values for each variable.

  Rule Triggers

  • On the rules create/edit page, we will include one more trigger i.e. Sprint completed
    Refer:

  • When this trigger is selected, rule shall gets triggered whenever a sprint is marked as completed in the project.

  • This rule trigger shall be available only in in-project ARN screen presently.

  Acceptance Criteria

  • Users should be able to include sprint variables in the template in all types of the templates.

  • System shall ask users to select sprint on version selector screen when sprint variables are used in the template. (in both in-project and cross-project screens.)

  • User should be able to use ‘sprint completed’ rule trigger and system shall trigger such rule whenever any sprint is marked as completed in the project.

  • All other features of ARN shall work as it is.