Versions Compared

Key

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

...

Throughout the documentation, we use some terms which we'd like to briefly explain before you continue.

Term

Comment

Versions hierarchy

The hierarchy of project versions

Item

Item or hierarchy item is an element which is added to the hierarchy. It is the link to a project version or folder

Version

Native Jira project version (release)

Folder

Custom hierarchy item type implemented in Versions hierarchy app

Versions hierarchy picker

The extension of version fieldstype to select versions from the hierarchy

Quick start guide

After installing the app a new project tab "Versions hierarchy" is added to Project navigation tab where you can manage project versions hierarchy aka Versions hierarchy organizer.

...

  • search/filter versions in the hierarchy by its name

  • add existing version/folder - add one or more existing versions/folders to the top of the hierarchy

  • add new version/folder - add new version/folder to the top of the hierarchy

  • expand/collapse all items in the hierarchy

  • find more details about the app and raise support request using Help menu.

  • import/export versions hierarchy from/to another project in the same or different Jira instance

...

Hierarchy item toolbar

Subcomponents Versions hierarchy consists of hierarchy items - links to corresponding components or versions and folders. Each hierarchy item has its context menu with a set of available actions.

...

Action

Description

Expand

Expand all nested items of the target item

View issues

View issues for the target item and all its children items

Edit

Edit version or folder details

Remove

Remove target item from the hierarchy. A confirmation dialog is displayed before the item is removed and contains the following information:

  • item is removed with all its children items, number of items is included

  • neither

components
  • versions nor folders are deleted, only their references in the hierarchy are removed

Add new version

Create and automatically add new version under of after target item

Add a new folder

Create and automatically add a new folder under of after target item

Add existing versions

Add one or more existing versions under of after target item

Add existing folders

Add one or more existing folders under of after target item

Manage hierarchy

Add new version

...

  • folder is an additional hierarchy item type to group other components versions or folders

  • folder has name (mandatory) and description attributes

  • unlike version, two different folders can have the same name

...

In the “Versions“ dialog all available project versions are displayed with the dialog you can select versions that you want to add to the hierarchy.

All available project components versions are displayed in a table with the following columns:

  • name - component version name

  • description - component version description

  • used in a hierarchy - how many times the component version is added to a hierarchy 

  • actions - component version context menu with edit and delete actions

...

In the “Versions” dialog you can also edit existing or create new versions without switching to the Releases project tab.

Version action

Description

Create

When new version is created in the Add versions dialog it is not added to hierarchy automatically. You would need to select and add it explicitly.

Edit

When version is updated the hierarchy is updated with new details automatically.

Delete

When version is deleted all its references from hierarchy are removed.

All nested items of the deleted version are removed from hierarchy as well.

If the deleted version is associated with some issues a popup dialog is displayed with options to swap issues to another version.

Filter versions

Use filters to find and select versions from the shorter list. Versions can be filtered by:

...

Edit and delete actions are located in each folder context menu.

Folder action

Description

Create

When a new folder is created in “Folders“ dialog it is not added to hierarchy automatically, you need to select and add it explicitly.

Edit

When a folder is updated the hierarchy is updated with new details automatically.

Delete

When a folder is deleted all its references from hierarchy are removed.

All nested items of a deleted folder are removed from hierarchy as well.

Filter folders

Use filters to find and select folders from the shorter list. Folders can be filtered by:

...

You can find issues for a particular part of the project represented by some version and its nested items:

...

  1. using hierarchy item View issues context action

  2. via JQL search with the help of custom JQL functions: subversions() and

...

  1. vhSubfolder()

View issues

Click on “View issues” action in the item context menu to open the View issues dialog with the list of issues.

...

In the example below there are three versions are organized in a three-level hierarchy where each version has one issue directly associated with it.

...

View issues The result for Version 1.0 component contains includes all three issues.

...

In the background View issues screen utilizes JQL search capabilities to find the required issues and you can switch to Jira Issue Navigator to get more details about the issues.

...

Versions hierarchy app adds two custom JQL functions to search issues in versions hierarchy: subversions and vrSubfoldervhSubfolder.

The result of both functions is a list of versions, that's why you should use them in a combination with version field, e.g. "fixVersion in subversions(…)".

Function

Parameters

Examples

subversions()

  1. project key - key of the project to search in

  2. version name - find issues for this version and all its nested versions

You can optionally provide the third parameter as "false" to exclude issues of current version from the result

  • fixVersion in subversions("DEMO", "Version 1.0")

  • affectVersion in subversions("DEMO", "Version 1.1", "false")

vrSubfolder

vhSubfolder()

  1. project key - key of the project to search in

  2. folder name - find issues for all hierarchy items under this folder

  • fixVersion in

vrSubfolder
  • vhSubfolder("DEMO", "folder 1")

Select

...

versions in issue

Now let's explore how users can select components versions from the hierarchy using Subcomponents Version hierarchy picker to add components versions to issue.

...

Versions hierarchy picker

Subcomponents Versions hierarchy picker is invoked via displayed when you click the action button with the hierarchy icon located next to Components any version field on the issue Create/Edit screen.

...

When you edit Components the version field inline Subcomponents Versions hierarchy picker action button is located in inline edit tools.

...

Subcomponents Versions hierarchy picker is a modal dialog with project components versions hierarchy.

...

Users can select components versions from the hierarchy and add them to issue in addition to selecting from the plain list.

Info

Subcomponents Versions hierarchy and Issue picker are fully supported in Jira Service Desk Management projects.

Customer portal users can take advantage of selecting components versions from subcomponents versions hierarchy when creating issues in the customer portal.

...

Versions hierarchy picker settings

Users can configure hierarchy being When Versions hierarchy picker is opened the hierarchy is displayed expanded or collapsed by default in Subcomponents picker via based on user settings.

...

Except expand/collapse default state the settings also contain configuration options to manage automatic select/unselect behavior for a of parent, sibling, and children items of the target item.

Option

Description

Bulk check parents

When a

component

version is selected also select all its

parent components

parent versions

Bulk check siblings

When a

component

version is selected also select all its sibling

components

versions

Bulk check children

When a

component

version is selected also select all its children

components

versions

Bulk uncheck parents

When a

component

version is unselected also unselect all its

parent components

parent versions

Bulk uncheck siblings

When a

component

version is unselected also unselect all its sibling

components

versions

Bulk uncheck children

When a

component

version is unselected also unselect all its children

components

versions