Notifications
Provided you have entered a working email address for your userid in the Helix Versioning Engine, Swarm sends email notifications to you when various events take place:
Legend:
| A = Author | PM = Project member | = role user receives notification |
| R = Reviewer | PF = Project follower | = role user does not receive notification |
| M = Moderator | AF = Author follower | = role not included for this event. |
| GM = Group member | CA = Comment author |
| Notification sent to one of these roles... | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Event | Event by you? | A | R | M | GM | PM | PF | AF | CA |
| A review is committed in Swarm | 3 | 4 | 1 | 1 | |||||
| A review is committed outside of Swarm | 3 | 4 | 1 | 1 | |||||
| A change is committed outside of Swarm (see below) | 3 | 4 | 1 | 1 | 1 | ||||
| A review is started | 3 | 4 | 2 | ||||||
| A reviewer casts a vote | 5 | ||||||||
| A review's state changes | 5 | ||||||||
| A review's reviewers are changed | 5 | ||||||||
| A review's files are updated | 5 | ||||||||
| A review's description is changed | |||||||||
| A review comment is created | 5 | 6 | |||||||
| A review comment is edited | 5 | 6 | |||||||
| A committed change comment is created | 6 | ||||||||
| A committed change comment is edited | 6 | ||||||||
| Someone joins or leaves a review | 5 | ||||||||
| Someone likes a comment you wrote | 5 | ||||||||
| You like a comment you wrote | |||||||||
Any custom modules added to Swarm may also send notifications.
Important
Email delivery for events related to restricted changes is disabled by default. See Restricted Changes for details on how to enable restricted change notifications.
@mention notifications
Using an @mention in a review, changelist, or comment causes the referenced userid to receive a notification and be included in any future notifications regarding the associated file or review.
When a comment is added to a job, Swarm sends a notification to users listed in user fields in the job, users @mentioned in the job description, and the authors of any associated changes.
Note
Typically, you would not receive a notification when you @mention yourself. @mentions themselves do not trigger notifications; they inform who receives notifications.
(1) Committed change notifications
Notifications for committed changes are sent by default, but can be disabled or require users to opt-in. Please see the notification configuration and adding a project for more details.
When committed change notifications are configured for opt-in, you need to
copy the configuration's special depot path to the
Reviews: field in your user spec within the Helix
Versioning Engine. Once you have done so, Swarm can send you committed
change notifications for any change that matches a depot path specified in
the Reviews: field.
Update Reviews with p4
-
Begin editing your user spec:
$ p4 user -
Edit the
Reviews:field to include the special depot path, plus any other paths you want to receive notifications for. -
Save the spec.
Update Reviews with P4V
-
Select .
-
Edit the
Reviews:field to include the special depot path, plus any other paths you want to receive notifications for. -
Click .
(2) Review start notifications
By default, notifications are sent when a review is started, but can be disabled for a project. See Add a project for details.
(3) Moderator notifications
Moderators are associated with specific project branches. Moderators receive notifications for reviews and commits against the branches they are associated with.
(4) Group member notifications
By default, notifications are not sent to group members for started review and committed changes, but can be selectively enabled. See Add a group for details.
(5) Disable notifications
By default, notifications for events in a review are sent to all reviewers. Reviewers can disable notifications during a review to avoid further email notifications. Once notifications are disabled for a reviewer, they can be re-enabled when they are specifically @mentioned; reviewers can disable notifications again after they have been re-enabled. See Disable notifications for details.
(6) Comment author notifications
By default, notifications are not sent to comment authors, but Swarm can be configured to send notifications of comments to comment authors. See notify_self for details.