...
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.
...
Versions hierarchy consists of hierarchy items - 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:
|
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
...
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:
...
using hierarchy item View issues context action
via JQL search with the help of custom JQL functions: subversions() and
...
vhSubfolder()
View issues
Click on “View issues” action in the item context menu to open the View issues dialog with the list of 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() |
You can optionally provide the third parameter as "false" to exclude issues of current version from the result |
|
vhSubfolder() |
|
|
|
Select versions in issue
Now let's explore how users can select versions from the hierarchy using Version hierarchy picker to add versions to issue.
...
Except expand/collapse default state the settings also contain configuration options to manage automatic select/unselect behavior of parent, sibling, and children items of the target item.
Option | Description |
|---|---|
Bulk check parents | When a version is selected also select all its parent versions |
Bulk check siblings | When a version is selected also select all its sibling versions |
Bulk check children | When a version is selected also select all its children versions |
Bulk uncheck parents | When a version is unselected also unselect all its parent versions |
Bulk uncheck siblings | When a version is unselected also unselect all its sibling versions |
Bulk uncheck children | When a version is unselected also unselect all its children versions |