2015-07-13 13:36:29 -04:00
|
|
|
# GitLab Notification Emails
|
2014-10-14 10:01:45 -04:00
|
|
|
|
2015-07-13 13:36:29 -04:00
|
|
|
GitLab has a notification system in place to notify a user of events that are important for the workflow.
|
2014-10-14 10:01:45 -04:00
|
|
|
|
|
|
|
## Notification settings
|
|
|
|
|
2016-05-31 16:51:46 -04:00
|
|
|
You can find notification settings under the user profile.
|
2014-10-14 10:01:45 -04:00
|
|
|
|
|
|
|
![notification settings](notifications/settings.png)
|
|
|
|
|
2014-10-14 10:12:22 -04:00
|
|
|
Notification settings are divided into three groups:
|
2014-10-14 10:01:45 -04:00
|
|
|
|
|
|
|
* Global Settings
|
|
|
|
* Group Settings
|
|
|
|
* Project Settings
|
|
|
|
|
|
|
|
Each of these settings have levels of notification:
|
|
|
|
|
|
|
|
* Disabled - turns off notifications
|
|
|
|
* Participating - receive notifications from related resources
|
|
|
|
* Watch - receive notifications from projects or groups user is a member of
|
|
|
|
* Global - notifications as set at the global settings
|
2016-06-17 11:38:49 -04:00
|
|
|
* Custom - user will receive notifications when mentioned, is participant and custom selected events.
|
2014-10-14 10:01:45 -04:00
|
|
|
|
|
|
|
#### Global Settings
|
|
|
|
|
|
|
|
Global Settings are at the bottom of the hierarchy.
|
2015-02-03 18:18:40 -05:00
|
|
|
Any setting set here will be overridden by a setting at the group or a project level.
|
2014-10-14 10:12:22 -04:00
|
|
|
|
|
|
|
Group or Project settings can use `global` notification setting which will then use
|
2014-10-14 10:01:45 -04:00
|
|
|
anything that is set at Global Settings.
|
|
|
|
|
|
|
|
#### Group Settings
|
|
|
|
|
2015-02-03 18:18:40 -05:00
|
|
|
Group Settings are taking precedence over Global Settings but are on a level below Project Settings.
|
2014-10-14 10:01:45 -04:00
|
|
|
This means that you can set a different level of notifications per group while still being able
|
|
|
|
to have a finer level setting per project.
|
|
|
|
Organization like this is suitable for users that belong to different groups but don't have the
|
|
|
|
same need for being notified for every group they are member of.
|
2016-06-22 09:50:19 -04:00
|
|
|
These settings can be configured on group page or user profile notifications dropdown.
|
2014-10-14 10:01:45 -04:00
|
|
|
|
|
|
|
#### Project Settings
|
|
|
|
|
2015-02-03 18:18:40 -05:00
|
|
|
Project Settings are at the top level and any setting placed at this level will take precedence of any
|
2014-10-14 10:01:45 -04:00
|
|
|
other setting.
|
|
|
|
This is suitable for users that have different needs for notifications per project basis.
|
2016-06-22 09:50:19 -04:00
|
|
|
These settings can be configured on project page or user profile notifications dropdown.
|
2014-10-14 10:01:45 -04:00
|
|
|
|
|
|
|
## Notification events
|
|
|
|
|
|
|
|
Below is the table of events users can be notified of:
|
|
|
|
|
|
|
|
| Event | Sent to | Settings level |
|
|
|
|
|------------------------------|-------------------------------------------------------------------|------------------------------|
|
|
|
|
| New SSH key added | User | Security email, always sent. |
|
|
|
|
| New email added | User | Security email, always sent. |
|
|
|
|
| New user created | User | Sent on user creation, except for omniauth (LDAP)|
|
|
|
|
| User added to project | User | Sent when user is added to project |
|
|
|
|
| Project access level changed | User | Sent when user project access level is changed |
|
|
|
|
| User added to group | User | Sent when user is added to group |
|
2016-05-31 16:51:46 -04:00
|
|
|
| Group access level changed | User | Sent when user group access level is changed |
|
2015-08-06 06:16:05 -04:00
|
|
|
| Project moved | Project members [1] | [1] not disabled |
|
2015-08-07 16:07:04 -04:00
|
|
|
|
2015-08-06 06:16:05 -04:00
|
|
|
### Issue / Merge Request events
|
|
|
|
|
|
|
|
In all of the below cases, the notification will be sent to:
|
|
|
|
- Participants:
|
|
|
|
- the author and assignee of the issue/merge request
|
|
|
|
- authors of comments on the issue/merge request
|
2016-08-15 10:15:20 -04:00
|
|
|
- anyone mentioned by `@username` in the issue/merge request title or description
|
2015-08-06 06:16:05 -04:00
|
|
|
- anyone mentioned by `@username` in any of the comments on the issue/merge request
|
|
|
|
|
|
|
|
...with notification level "Participating" or higher
|
|
|
|
|
2016-05-16 12:34:10 -04:00
|
|
|
- Watchers: users with notification level "Watch"
|
2015-08-06 06:16:05 -04:00
|
|
|
- Subscribers: anyone who manually subscribed to the issue/merge request
|
2016-05-31 16:51:46 -04:00
|
|
|
- Custom: Users with notification level "custom" who turned on notifications for any of the events present in the table below
|
2015-08-06 06:16:05 -04:00
|
|
|
|
|
|
|
| Event | Sent to |
|
|
|
|
|------------------------|---------|
|
|
|
|
| New issue | |
|
|
|
|
| Close issue | |
|
|
|
|
| Reassign issue | The above, plus the old assignee |
|
|
|
|
| Reopen issue | |
|
|
|
|
| New merge request | |
|
|
|
|
| Reassign merge request | The above, plus the old assignee |
|
|
|
|
| Close merge request | |
|
|
|
|
| Reopen merge request | |
|
|
|
|
| Merge merge request | |
|
|
|
|
| New comment | The above, plus anyone mentioned by `@username` in the comment, with notification level "Mention" or higher |
|
2015-08-10 19:03:10 -04:00
|
|
|
|
2016-08-15 10:15:20 -04:00
|
|
|
|
|
|
|
In addition, if the title or description of an Issue or Merge Request is
|
|
|
|
changed, notifications will be sent to any **new** mentions by `@username` as
|
|
|
|
if they had been mentioned in the original text.
|
|
|
|
|
2015-08-10 19:03:10 -04:00
|
|
|
You won't receive notifications for Issues, Merge Requests or Milestones
|
|
|
|
created by yourself. You will only receive automatic notifications when
|
|
|
|
somebody else comments or adds changes to the ones that you've created or
|
2015-08-10 19:05:59 -04:00
|
|
|
mentions you.
|