| Table of Contents |
|---|
...
Any Tab
...
Versions tab of the Release board enables you to:
explore all versions from projects added to the board
change status of any version using drag-and-drop
organize versions rank in the column using drag-and-drop
Versions are displayed as cards with the following information:
name
start date
release date and delay status
project details (icon and key)
...
Type of Versions
Release Management App is built around 2 type of versions, namely
fixVersion - standard versions reside in the projects (also called as Jira Releases)
Virtual Versions - the versions that are proprietary to Release Management App only and could be
Epic based
Sprint based (coming early 2022)
Custom JQL based
Throughout this section and the rest of documentation when we use a notion of “version“ both fixVersion and Virtual Version. In case, there are limitations or difference in use cases an appropriate notice will be made.
Common operations with Versions
Create version
You can create new versions directly from the board, without any need to navigate between projects, and use the built-in create version function.
Fix Version
Click "Create > Create version" button to open a new version dialog:
...
Project. Select a project host for a new version. Only the board projects where the current user has "Create version" permissions are available.
...
Name. Version name along with Project are the only mandatory fields.
...
Packages. To specify a list pf packages that a version belongs to.
...
Start date, Release date. Self-explanatory.
Click the "Save" button to create a new version that will be placed at the bottom of the default “unreleased” board column. You can also tick “Click another“ to create yet another version with similar details.
Virtual Version (Epic, Sprint or JQL Version)
Click “Create > Create virtual version“ to open new version dialog:
...
By default the version is JQL-based and you need to specify a valid JQL that will be executed by your Jira Instance.
If you want to derive the version from Epic toggle the Epic trigger and select Epic from the list.
The rest of the fields are the same as fixVersion.
...
/View … Same Version
We have different tabs/views in the App to outline versions and versions are depicted also differently, namely
as Card on Board view in specific Column/Status (read how to configure https://releasemanagement.atlassian.net/wiki/spaces/RMC/pages/92078312/Configure+Release+Board+Settings#Card-layout)
as Bar on Roadmap view according to Start/Release Dates
as Event on Calendar view according to Release Date
as Row on List view
But apparently this is same version an clicking on it will open up same Version Details dialog
Type of Versions
Please refer to Release Anything (or Taxonomy of Releases) section of this documentation to understand different type of versions we support. In the rest paragraphs of this section we will treat version as one of Fix Versions, Cross Project Versions or Virtual Versions (Epics, Sprints and JQL Versions). If we do not make difference the logic/functionality applies to all types. In case some logic/functionality is limited to specific version type we will outline it explicitly.
Common Operations with Versions
Creating & Editing Version
Please refer to Release Anything (or Taxonomy of Releases) section of this documentation to understand how to create different type of versions.
Archiving Versions
Right click on any version to choose Archive. Or click on any version to open Version Details dialog, scroll to bottom to find Actions menu and choose Archive.
...
Archiving is just a flag to show that version is probably very old and you do not need any more on your screen so the loading time is improved.
Deleting Versions
Right click on any version to choose Delete. Or click on any version to open Version Details dialog, scroll to bottom to find Actions menu and choose Delete.
...
| Info |
|---|
|
Tagging versions
Read more about Tags for Packages and Versions
Merging versions
Only for Fix Versions and not supported for Virtual Versions.
You can easily merge version into another. To do so right click on the version you want to merge
...
or click on it to find “Merge“ in actions menu
...
You will be asked to select a destination version
| Info |
|---|
Versions for the same project will be suggested only. |
...
Upon confirmation all the issues will be reassigned to destination version and the source version will be deleted.
Versions Workflow
Configure versions workflow
...
Unreleased is usually used for Todo, In Progress, Integration testing and UAT, etc.
Released is usually is used for Done
Mark version as Released/Unreleased
When you move a version to another column the version status is automatically changed to released or unreleased based on the destination column mapping.
...
| Note |
|---|
A version can be moved from an "Unreleased" status column to a "Released" status column, provided that the user has appropriate permissions for the version's project. |
Version
...
Details dialog
Summary
...
tab
By clicking on a version card on the release board the Version Details dialog is shown. By default, “Summary” tab is displayed. For all the future occurrences the system will remember your last tab and navigate you to it.
You can view and update the following version fields using inline editing:
name
description
packages
status
start date
release date
...
Name
Description
Alternative Description (via Custom Properties of Paragraph Type)
Packages
Projects (edit for Cross-Project virions only, view for Fix versions only)
Tags (Tags for Packages and Versions )
Status/Column
Start date
Release date
Projected release date (if configured)
Custom Properties (read more)
...
| Info |
|---|
For Virtual Versions summary includes |
...
additional controls to edit Epic, Sprint, JQL. For Cross-Project versions Projects list is editable. |
On the top`right corner of the dialog you can see an icon to copy deep link for the versions to use externally. also ability to zoom in/out dialog if you have a lot of data.
Projected release date (PRD) & release delay duration
...
When version is delayed the “Release date” is highlighted with red color and the delay duration in days is displayed next to it.
...
View on roadmap. You will be redirected on roadmap view and your selected version or package will be highlighted.
Release Notes. You will be redirected to release notes screen to select appropriate template for your version and generate your notes.
Reports. Choose one of the reports you want to generate for your version.
Actions
Convert to package - allows to convert virtual versions into package. This will create appropriate fix versions in all the effected projects and re-assign issues to those fix versions. Plus all the versions will be licked to new package.
Archive
Delete
...
Milestones Tab
In addition to custom workflows for versions and packages, Release Management app allows to create intermediate milestones for both that could be
...
For more details please navigate to Milestones "on the way" section of this documentation.
Dependencies Tab
Navigate to Release Dependencies section of this documentation to learn more about Versions inbound and outbound dependencies.
Issues
...
Tab
You can browse all issues assigned to the selected version on the “Issues” tab of Version details dialog.
...
If issue type that you are trying to create demands few other mandatory fields we will show Jira standard “Issue Creation“ dialog to try again.
Commits
...
Compass
If you use a notion of Component versions and use Atlassian Compass following Atlassian Compass Integration section of this documentation. Classical (project bound components) will be supported shortly.
Commits/Deployments
Git, Bitbucket, CI/CD tools Integrations
Environments
To understand to witch environments the current versions is deployed please navigate to Environments section of this documentation.
🚀 Swimlanes for versions
Swimlanes functionality on the board view are aligned with Swimlanes on the Roadmap view and Groups on List view.
You can group version per project, tag or issue type. Few sorting options are also available.
But the most widely used case is grouping by packages (or cross project releases) .
...
If the same version is added to several packages and “Package swimlanes” are enabled then it will be displayed in every package swimlane.
| Info |
|---|
When such a version is moved to another column on one swimlane it will be automatically moved to the same column on all other swimlanes. |
Automation for versions
Read more about Release Automation to create automation rules for versions with various triggers, conditions and actions.
But there are also some hard coded rules in the App, namely:
Move unfinished tasks to another/new version
If you release the version with some unfinished tasks we will detect it to offer you move them to next/upcoming version if it exists or create a new one
...
Merge versions
Only for Fix Versions and not supported for Virtual Versions.
You can easily merge version into another. To do so right click on the version you want to merge
...
or click on it to find “Merge“ in actions menu
...
You will be asked to select a destination version
| Info |
|---|
Versions for the same project will be suggested only. |
...
Upon confirmation all the issues will be reassigned to destination version and the source version will be deleted.
...
Multi-select and bulk operations
With Ctrl+ users can select multiple versions on the board. Thus they can move them to destination column all together:
...