Wiki
Clone wikiversion-manager-cloud / Home
Welcome to Version Manager for JIRA Cloud's documentation!
Overview
Jira allows only project administrators to manage versions, therefore, users want to delegate version management to the users of their choice.
Version manager for JIRA enables you to choose who to grant the permissions to create, edit and delete versions. Moreover, it provides a new version management page including an editable table.
Another useful feature is allowing versions for components: the add-on lets you assign a component to a version instance and then filter by the components you would like to view. One can also chose to enforce version - component mapping with a built-in workflow validation.
Installation
The product is available at Atlassian Marketplace. Please find further instructions for installation on the app page in the marketplace.
Configuration
- Login to JIRA as an administrator
- Choose a project
- Click on "Project settings" on the side bar
- Scroll down and click on "Permissions" on the project settings side bar
- Locate "Manage Versions" on the main screen under "Project Permissions"
- On the top right corner you will find a button named "Actions", after clicking on it a dropdown will appear with "Edit permissions" option
- Go to "Manage Versions" and click the "Edit" Link next to it
- On the dialog, choose who to grant the permission
- You can also revoke permissions by clicking "Remove" instead of "Edit"
Version management
A new menu item called "Versions" will be added to the project page for those who were granted permissions and project administrators. The link will direct you to a new version management page with the following features:
- Create version
- Edit version
- Delete version
- Merge versions
- Assign a component to a version
- Filter by name
- Filter by status
- Filter by component
The page shows all the available versions of the project which match the specified criteria in an editable table view. Edit, merge and delete versions are done using the buttons of each row. If you want to create version click the "Create version" button on the top right of the table, then a new row will be added to the table. Each of the following operations requires to approve (V) or cancel it after providing the input.
Another option to find a specific version is to use the filters on the top left corner of the table : search by name or by status. Changing the values will causes the table to refresh with the filtered results.
Version - Component Validation
Want to enforce users to assign the right versions in relation to the components? The plugin comes with a built-in workflow validator that enables you to do that!
To add a validator follow these instructions:
- Select the Jira icon > Jira settings > Issues.
- Click Workflows and then Edit for the relevant workflow.
- In diagram mode, select the transition arrow. In text mode, select the transition's name from the Transitions (id) column.
- In diagram mode, click Validators in the properties panel to show the triggers configured for the transition. In text mode, select the Validators tab.
- Click add validator, choose "Versions match the chosen components" and then click add.
We recommend to add the validator to "Create" transition and to every state transition that is relevant to your workflow (since there is no "edit" transition).
Kanban board Release functionality
A new "Release" button will show on the Kanban boards with 2 links: "New version" and "Existing versions".
Each of the links opens a dialog with different functionality:
- New version - create a new version for done issues that are missing a version.
- Existing versions - choose an unreleased version to release. At least one related issue should be done.
- Resolved version - all related issues are done.
- Partially resolved version - some related issues are unresolved. If you choose a version from this category, you will be prompted with the question - what to do with the unresolved issues? two options are presented: ignore or move issues to a selected version.
Note:
- The new release button will not show to admin users because they have full control using the Jira release button.
- Every other logged in user will see the release button, however only those with the "manage versions" permissions will be able to release any version.
- Board with multiple projects are fully supported.
Implementation
- The add-on works with the same versions as JIRA. All past data and JIRA built-in features will continue to function.
- When assigning a component to a version, the app concatenates the component name to the JIRA version entity.
Issues and bugs
Please report bugs or feature requests in the issue tracker.
Updated