Notifications
Provided you have entered a working email address for your userid in the Perforce service, Swarm sends email notifications to you when various events take place:
= role user receives notification
| Notification sent to one of these roles... | ||||||
|---|---|---|---|---|---|---|
| Event | Event by you? | Author | Reviewer | Project Member | Project Follower | Author Follower |
| A review is committed in Swarm | * | * | ||||
| A review is committed outside of Swarm | * | * | ||||
| A change is committed outside of Swarm (see below) | * | * | * | * | * | |
| A review is started | ||||||
| A reviewer casts a vote | ||||||
| A review's state changes | ||||||
| A review's files are updated | ||||||
| A review's description is changed | ||||||
| A review comment is created | ||||||
| A committed change comment is created | ||||||
| Someone joins a review | ||||||
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.
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 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 Perforce
service. 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 .