notifications.md 4.5 KB
Newer Older
K
karen Carias 已提交
1
# GitLab Notification Emails
M
Marin Jankovski 已提交
2

K
karen Carias 已提交
3
GitLab has a notification system in place to notify a user of events that are important for the workflow.
M
Marin Jankovski 已提交
4 5 6

## Notification settings

7
You can find notification settings under the user profile.
M
Marin Jankovski 已提交
8 9 10

![notification settings](notifications/settings.png)

11
Notification settings are divided into three groups:
M
Marin Jankovski 已提交
12 13 14 15 16 17 18 19 20 21 22

* 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
23
* Custom - Notification is set based on events selected by the user.(Available only in project level)
M
Marin Jankovski 已提交
24 25 26 27

#### Global Settings

Global Settings are at the bottom of the hierarchy.
28
Any setting set here will be overridden by a setting at the group or a project level.
29 30

Group or Project settings can use `global` notification setting which will then use
M
Marin Jankovski 已提交
31 32 33 34
anything that is set at Global Settings.

#### Group Settings

35
Group Settings are taking precedence over Global Settings but are on a level below Project Settings.
M
Marin Jankovski 已提交
36 37 38 39 40 41 42
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.

#### Project Settings

43
Project Settings are at the top level and any setting placed at this level will take precedence of any
M
Marin Jankovski 已提交
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
other setting.
This is suitable for users that have different needs for notifications per project basis.

## 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 |
59
| Group access level changed   | User                                                              | Sent when user group access level is changed |
D
Douwe Maan 已提交
60
| Project moved                | Project members [1]                                               | [1] not disabled |
K
karen Carias 已提交
61

D
Douwe Maan 已提交
62 63 64 65 66 67 68 69 70 71 72
### 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
  - anyone mentioned by `@username` in the issue/merge request description
  - anyone mentioned by `@username` in any of the comments on the issue/merge request

    ...with notification level "Participating" or higher

F
Felipe Artur 已提交
73
- Watchers: users with notification level "Watch"
D
Douwe Maan 已提交
74
- Subscribers: anyone who manually subscribed to the issue/merge request
75
- Custom: Users with notification level "custom" who turned on notifications for any of the events present in the table below
D
Douwe Maan 已提交
76 77 78 79 80 81 82 83 84 85 86 87 88

| 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 |
K
karen Carias 已提交
89 90 91 92

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
K
karen Carias 已提交
93
mentions you.