Lockstep - Version & Component Sync for Jira: user guide
Lockstep keeps the versions and components of several Jira projects identical. You manage them in one source project and the app copies every change to the target projects you choose.
Who can use it
Only Jira administrators can open the settings and change rules. Everyone else simply sees the synced versions and components in their projects.
Getting started
- In Jira, open Settings > Apps and choose Lockstep in the sidebar.
- Under Add a rule, pick the source project. This is where you will create and edit versions and components from now on.
- Pick one or more target projects (up to 10 per rule).
- Choose what to sync: versions, components or both.
- Select Add rule.
- Select Preview on the new rule. Nothing is changed yet; you get a list of what would be created or updated in each target.
- If the list looks right, select Sync now.
From this point on, changes in the source project are copied automatically, usually within a few minutes.
What is synced
| Synced | Not synced | |
|---|---|---|
| Versions | name, description, start date, release date, released and archived status | order of versions, merging of versions |
| Components | name, description | component lead, default assignee |
A version or component in a target is matched to the source by name the first time. After that the app remembers the pair, so renaming in the source renames the copy instead of creating a new one.
Sync is one-way. Changes made directly in a target project are not copied back, and they are overwritten the next time the same item changes in the source or you select Sync now.
Rules do not chain. If project A syncs to B and B syncs to C, a change in A reaches B but not C. Add C as a target of A instead.
Deleting
By default nothing is ever deleted in target projects. If you delete a version in the source, its copies stay.
If you want deletions mirrored, switch on Also delete in targets when deleted in the source when you create the rule. A version or component deleted in the source is then deleted in every target and removed from the issues that use it there. This cannot be undone.
Only items the app has already synced are deleted. A version in a target that merely has the same name, and was never part of a sync, is left alone.
Merging two versions in the source is never mirrored, even with this option on.
Activity log
Recent activity shows the last 100 actions with their result. A failed action shows the message returned by Jira, for example when a name is already taken in the target project.
Troubleshooting
A change did not appear in a target project. Jira delivers change notifications to apps with a delay of up to a few minutes. If it still has not appeared, open the settings, check Recent activity for an error and select Sync now.
The log shows a 403 or permission error.
The app needs the Administer Projects permission in the target projects. Jira grants this to apps by default through the atlassian-addons-project-access project role. If your permission scheme was customised, add that role back to Administer Projects and Browse Projects.
The log shows "name already exists". The target project already has a different version or component with that name. Rename or remove it in the target and select Sync now.
Syncing is paused because the license is inactive. Renew the app subscription in Settings > Apps > Manage apps. Your rules are kept and syncing resumes by itself.
Limits
- 50 rules per site and 10 target projects per rule.
- A manual sync of a very large project runs in batches; the page keeps going until everything is done.
Data and privacy
All data stays inside Atlassian. The app stores your sync rules, the list of matched pairs and the activity log in Atlassian-hosted app storage, and it makes no connections to any external server.
Support
Support page · martin@lunvio.sk
We answer critical requests within 24 hours and all others within 5 business days.