BigW Consortium Gitlab

notifications.md 4.9 KB
Newer Older
1
# GitLab Notification Emails
2

3
GitLab has a notification system in place to notify a user of events that are important for the workflow.
4 5 6

## Notification settings

7
You can find notification settings under the user profile.
8 9 10

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

11
Notification settings are divided into three groups:
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 - user will receive notifications when mentioned, is participant and custom selected events.
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
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.
36 37 38 39
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.
40
These settings can be configured on group page or user profile notifications dropdown.
41 42 43

#### Project Settings

44
Project Settings are at the top level and any setting placed at this level will take precedence of any
45 46
other setting.
This is suitable for users that have different needs for notifications per project basis.
47
These settings can be configured on project page or user profile notifications dropdown.
48 49 50 51 52 53 54 55 56 57 58 59 60

## 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 |
61
| Group access level changed   | User                                                              | Sent when user group access level is changed |
Douwe Maan committed
62
| Project moved                | Project members [1]                                               | [1] not disabled |
63

Douwe Maan committed
64 65 66 67 68 69
### 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
70
  - anyone mentioned by `@username` in the issue/merge request title or description
Douwe Maan committed
71 72 73 74
  - anyone mentioned by `@username` in any of the comments on the issue/merge request

    ...with notification level "Participating" or higher

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

| 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 |
91

92 93 94 95 96

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.

97 98 99
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
100
mentions you.