Documentation

This is the documentation for the Atlassian Jira app Version Sync for Jira.

Installation

Head to the settings within Jira. Note that administrator privileges are required to access the settings.

In the menu on the left side, navigate to “Find new apps” under the “Apps” category. Search for “Version Sync”, wait until the entry “Version Sync for Jira” is shown and proceed to “Install” the add-on.

Access the Version Sync menu

After having installed the app from the Atlassian Marketplace, you can start using Version Sync in right away!

Classic projects: Navigate to Project > Project settings > Version sync

Next-gen projects: Navigate to Project > Project settings > Apps > Version sync

Note: If no versions are visible in your next-gen project, you have to activate “Releases and versioning” first: Project > Project settings > Features > Releases and versioning

Tutorial video

How to sync versions

You want to sync the following versions:

• Navigate to the Version Sync menu of your project.
• Create your first group of projects that versions will be automatically synced across, by clicking on the “Create new group” button. The following dialog will appear:

Select all versions that you’d like to sync with other projects and click the “Create” button. Note that the checkbox at the bottom of the dialog will automatically sync newly added versions across all projects of the group. Since this is the only project in this group for now, this has no effect yet. The “Version Sync” page will be updated as follows:

You can change the group this project is attached to at any time. You can also “unsynchronize” any versions or the entire project, or change the automatic sync of added versions within the group. At the very bottom, you can see an activity log where all actions taken by the app are recorded.

In order to sync versions across projects, head to another project to sync those versions with. In our case, the same versions already exist in the other project, but without the release-dates and descriptions:

Go to the “Version Sync” page in the other project. Choose the group that was just created and hit the “Save” button. The following dialog will appear:

You can now choose which project versions should we synchronized with the group. Note that the project versions will be renamed and their details like description, release-dates and released/archived status will be synchronized once you hit the “Save” button. In our example, both the activity log and the Versions page will show that the versions have been properly synchronized:

If we now add a version to any of the two projects in this group, it will automatically be synchronized to the other one:

The same applies if an existing version is changed, released or archived. However, if a version in a group is deleted, the other versions are not automatically deleted, since the version to migrate existing issues into needs to be specified.

Release overview

The release overview of Version Sync for Jira has the same function as the Jira Releases screen. The important difference is, that it refers not only to the issues in this project but to all issues which are in the synced versions. 

This is how you navigate to “Releases – Version Sync for Jira”.

Please note: The “Releases – Version Sync for Jira” menu item is only displayed when the project is in a Version Sync group.

Classic projects/ Next-gen projects

• Select any project which contains the synced version
• Navigate to “Releases-Version Sync”

Use cases

Sync existing and future versions between project A and project B

1. Go to Version Sync in Project A (Classic: Project A > Project settings > Version Sync/ Next-gen: Project A > Project Settings > Apps > Version Sync)
2. Create new group “PA” with default settings
3. Go to Version Sync in Project B (Classic: Project B > Project settings > Version Sync/ Next-gen: Project B > Project Settings > Apps > Version Sync)
4. Select the group “PA” 
5. Select the desired outcome for synchronization
6. Save
7. If applicable sync existing versions from Project B manually. Please note: Future version will be synced automatically.

Duplicate existing and future versions from Project A to Project B

1. Go to Version Sync in Project A (Classic: Project A > Project settings > Version Sync/ Next-gen: Project A > Project Settings > Apps > Version Sync)
2. Click “Duplicate versions to a target project” on the top of the screen
3. Select Project B as target project
4. Save
5. Note: Current versions of Project A are displayed
6. Save

Please note: With that configuration versions will be synced from Project A to Project B. But not from Project B to Project A.

Known problems

There are no known problems so far. Please reach out to us if you encounter any issues while using the app!

Support

If you encounter any further problems, feel free to contact our support team. We’ll usually reply within one business day.

Thanks for using Version Sync for Jira!