📘 What you will learn here
On this page you will learn how to set up comments sync, which copies comments between linked work items, keeps edits in step and removes copies when the original comment is deleted.
This page is for Jira administrators who set up sync rules. You set it up in the Comments card under Special contents on the Field mapping tab of a sync rule.
Turn on comments sync
-
Open the sync rule and go to the Field mapping tab.
-
Under Special contents, turn on the Comments card. It expands to show its settings.
-
Set the Direction.
-
Optional: click the Transform chip to change how the comment text is written.
-
Optional: click Add filter to choose which comments sync.
-
Click Save changes.
Settings
|
Setting |
What it does |
Notes |
|---|---|---|
|
Direction |
Source → Target copies comments from This Jira site to the other site. Target → Source copies comments from the other site to This Jira site. Both directions does both. |
Default: Source → Target. The rule's push or pull must be turned on for the direction to take effect. |
|
Transform |
Direct copy or Smart value. |
Default: Direct copy. See How comments appear on the other site. |
|
Filters (optional) |
With no filter, all comments sync. With filters, only comments that match all of them sync. |
See Filters. |
When comments sync
Push
To copy comment changes right away, turn on these events under Jira events on the Configuration tab:
-
Comment added
-
Comment edited
-
Comment deleted
Every push of a work item also compares all of its comments with what was synced before, whatever triggered the push. So a comment change that was missed is caught up the next time the work item syncs, for example on a Work item updated event or a manual sync.
When a work item is pushed for the first time, its existing comments are copied too, subject to the filters.
Pull
Each time the rule pulls, Sync Bridge compares the comments on the linked work item on the other site with what was synced before, and adds, updates or deletes comments on This Jira site. Pull works only for work items that are already linked.
How comments appear on the other site
|
Transform |
Result |
|---|---|
|
Direct copy |
The comment body is copied as is, with its formatting. No author line is added. |
|
Smart value |
The comment is built from your template and written as plain text. Formatting, images and mentions of the original aren't kept. Example: |
A copied comment is added by the account the connector signs in with when it goes to the other site, and by the Sync Bridge app when it comes to This Jira site. The original author isn't the author of the copy. To show who wrote the comment, use a Smart value template with {{comment.author.displayName}}. All comment paths are listed on Smart Values and Transformations; use Test template to preview the result with the latest comment of a work item.
Filters
Click Add filter and pick a filter. Each filter can be added once. To remove one, click the X next to it.
|
Filter |
Options |
Notes |
|---|---|---|
|
Visibility |
Public and internal comments, Public comments only, Internal comments only |
Default when added: Public comments only. Applies only to Jira Service Management spaces. Comments in other spaces are treated as public. Internal comments that sync are added as regular, unrestricted comments on the other system. |
|
Author |
Only these authors, Exclude these authors |
Default when added: Only these authors. Select people with Search for people or paste an account ID. Add at least one person, or remove the filter. |
Internal comments that sync become public on the other site. If the other site's customers must not see your internal notes, add the Visibility filter with Public comments only.
The Author filter matches Atlassian account IDs, which are the same on every Jira Cloud site, so it works for both directions.
Edits and deletes
|
Change on the original comment |
Result on the copy |
|---|---|
|
Edited |
The copy is updated. |
|
Deleted |
The copy is deleted. |
|
No longer matches the filters, for example it was made internal or the filters changed |
The copy is deleted at the next sync of the work item. |
Changes to a copy aren't synced back. Editing or deleting a copied comment doesn't change the original, and the copy is overwritten the next time the original is edited.
With Both directions, each comment is copied once: a copy isn't copied back to the site it came from.
Failures
If some comments can't be added, updated or deleted, the comment part of the sync is recorded as failed in Sync History with the reason for each comment. Fields and other parts of the sync still run. Comments that didn't sync are tried again at the next sync of the work item.