GitLab 通知メール
GitLab Notifications を使うと、GitLab で何が起きているのかを常に知ることができます。 Notifications を有効にすると、イシュー、マージリクエスト、エピックでのアクティビティに関する最新情報を受け取ることができます。 Notifications はメールで送信されます。
通知の受信
以下のいずれかの理由で通知が届きます:
- イシュー、マージリクエスト、またはエピックに参加します。 ここでいう_参加とは_、コメントや編集を意味します。
- イシュー、マージリクエスト、エピックで通知を有効にします。 通知を有効にするには、サイドバーの通知トグルをクリックして_オンに_します。
通知を有効にすると、そのイシュー、マージリクエスト、エピックで発生したアクションの通知を受け取ることができます。
通知の調整
GitLabでは、受け取る通知の量を調整することができます。 例えば、特定のプロジェクトのすべてのアクティビティについて通知を受けたいけれど、他のプロジェクトでは自分の名前が言及されたときだけ通知を受けたい、などです。
通知設定を組み合わせることで、受信する通知を調整できます:
通知設定の編集
通知設定を編集するには
- プロフィール画像をクリックし、「設定」を選択します。
- 左サイドバーの「通知」をクリックします。
- 編集した設定は自動的に保存され、有効になります。
これらの通知設定はあなただけに適用され、同じプロジェクトやグループの他の人が受け取る通知には影響しません。
グローバル通知設定
プロジェクトやグループで異なる値を選択しない限り、グローバル通知設定がデフォルト設定となります。
- 通知メール
- このメールアドレスにお知らせが届きます。
- グローバル通知レベル
- これは、すべての通知に適用されるデフォルトの通知レベルです。
- 自分のアクティビティに関する通知を受け取ります。
- 自分のアクティビティに関する通知を受け取りたい場合は、このチェックボックスにチェックを入れてください。 デフォルト:チェックされていません。
通知範囲
プロジェクトやグループごとに異なる通知レベルを選択することで、通知の範囲を調整できます。
通知範囲は、優先順位の高いものから順に適用されます:
- プロジェクト
- プロジェクトごとに、通知レベルを選択できます。 プロジェクトの設定がグループの設定より優先されます。
- グループ
- グループごとに、通知レベルを選択できます。 グループの設定は、デフォルトの設定より優先されます。
- グローバル(デフォルト)
- アクティビティが発生したプロジェクトまたはグループの通知レベルを選択していない場合は、グローバルまたは_デフォルトの_通知レベルが適用されます。
プロジェクト通知
プロジェクトごとに通知レベルを選択できるので、特定のプロジェクトのアクティビティを細かく監視する必要がある場合に便利です。
プロジェクトの通知レベルを選択するには、以下のいずれかの方法を使用します:
- プロフィール画像をクリックし、「設定」を選択します。
- 左サイドバーの「通知」をクリックします。
- プロジェクトセクションでプロジェクトを探します。
- 希望の通知レベルを選択します。
または:
- プロジェクトのページに移動します。
- ベルのアイコンが付いた通知ドロップダウンをクリックします。
- 希望の通知レベルを選択します。
新しいリリースが利用可能になったときに通知を受ける方法については、リリースの通知をご覧ください。
グループ通知
グループごとに通知レベルとメールアドレスを選択できます。
グループ通知レベル
グループの通知レベルを選択するには、以下のいずれかの方法を使用します:
- プロフィール画像をクリックし、「設定」を選択します。
- 左サイドバーの「通知」をクリックします。
- グループセクションでプロジェクトを探します。
- 希望の通知レベルを選択します。
- グループのページに移動します。
- ベルのアイコンが付いた通知ドロップダウンをクリックします。
- 希望の通知レベルを選択します。
グループ通知メールアドレス
GitLab 12.0 で導入されました。
例えば、フリーランスで仕事をしていて、クライアントのプロジェクトに関するメールを分けたい場合などに便利です。
- プロフィール画像をクリックし、「設定」を選択します。
- 左サイドバーの「通知」をクリックします。
- グループセクションでプロジェクトを探します。
- ご希望のメールアドレスを選択してください。
通知レベル
プロジェクトやグループごとに、以下のレベルのいずれかを選択できます:
レベル | 説明 |
---|---|
グローバル | グローバル設定が適用されます。 |
見る | アクティビティに関する通知を受け取ります。 |
言及について |
@mentioned 、コメントで通知を受け取ります。
|
参加 | 参加したスレッドの通知を受け取ります。 |
無効 | 通知をオフにします。 |
Custom | カスタム選択したイベントの通知を受け取ります。 |
通知イベント
ユーザーには以下のイベントが通知されます:
イベント | 送付先 | 設定レベル |
---|---|---|
新しいSSHキーを追加しました。 | ユーザー | セキュリティメールは常に送信されます。 |
新規メール追加 | ユーザー | セキュリティメールは常に送信されます。 |
Eメール変更 | ユーザー | セキュリティメールは常に送信されます。 |
パスワード変更 | ユーザー | セキュリティメールは常に送信されます。 |
新規ユーザー作成 | ユーザー | OmniAuth を除き、ユーザー作成時に送信されます。(LDAP) |
プロジェクトにユーザーを追加 | ユーザー | ユーザーがプロジェクトに追加されたときに送信されます。 |
プロジェクトアクセスレベル変更 | ユーザー | ユーザープロジェクトのアクセスレベルが変更されたときに送信されます。 |
グループに追加されたユーザー | ユーザー | ユーザがグループに追加されたときに送信されます。 |
グループアクセスレベルの変更 | ユーザー | ユーザーグループのアクセスレベルが変更されたときに送信されます。 |
プロジェクト移動 | プロジェクトメンバー (1) | (1) 無効 |
新作 | プロジェクトメンバー | カスタム通知 |
イベント / エピック / マージリクエストイベント
以下のほとんどの場合、通知は以下の宛先に送信されます:
- 参加者
- イシュー/マージ・リクエストの作成者および担当者
- イシュー/マージリクエストのコメント作成者
-
@username
、イシュー、マージリクエスト、またはエピックのタイトルまたは説明で言及された人。 -
@username
、イシュー、マージリクエスト、またはエピックに関するコメントで言及された、通知レベルが「参加」以上の人。@username
- ウォッチャー:通知レベルが “Watch “のユーザー
- 購読者: そのイシュー、マージリクエスト、またはエピックに対して手動で購読した人。
- カスタム: 通知レベル「カスタム」のユーザで、以下の表のいずれかのイベントの通知をオンにしたユーザ。
イベント | 送付先 |
---|---|
イシュー | |
イシューを閉じる | |
イシューの再割り当て | 上記と旧担当者 |
イシューの再開 | |
イシュー | このイベントを選択した参加者とカスタム通知レベル |
マイルストーン変更イシュー | このイベントを選択した購読者、言及された参加者、およびカスタム通知レベル |
マイルストーン問題の削除 | このイベントを選択した購読者、言及された参加者、およびカスタム通知レベル |
新しいマージリクエスト | |
マージリクエストへのプッシュ | このイベントを選択した参加者とカスタム通知レベル |
マージリクエストの再割り当て | 上記と旧担当者 |
マージリクエストを閉じる | |
マージリクエストの再開 | |
マージリクエスト | |
マイルストーン変更マージリクエスト | このイベントを選択した購読者、言及された参加者、およびカスタム通知レベル |
マイルストーンマージリクエストの削除 | このイベントを選択した購読者、言及された参加者、およびカスタム通知レベル |
新着コメント | 上記に加えて、@username がコメントで言及した、通知レベルが「Mention」以上の人。
|
失敗したパイプライン | パイプラインの作成者 |
固定パイプライン | パイプラインの作成者。 デフォルトで有効。 GitLab 13.1 で導入されました。管理者は、ci_pipeline_fixed_notifications 機能フラグを使って、この通知オプションを無効にすることができます。
|
成功したパイプライン | パイプラインの作成者が、成功したパイプラインのカスタム通知設定を設定している場合。パイプラインが以前に失敗した場合、失敗後に最初に成功したパイプラインに対してFixed pipeline メッセージが送信され、その後成功したパイプラインに対してSuccessful pipeline メッセージが送信されます。
|
新しいエピック | |
近いエピック | |
エピック再開 |
さらに、イシューやマージリクエストのタイトルや説明が変更された場合、@username
、元のテキストで言及されていたかのように、新しい言及に対して通知が送信されます。
自分自身で作成したイシュー、マージリクエスト、マイルストーンには通知が届きません(イシューの期限が迫っている場合を除く)。 他の誰かが自分が作成したイシューにコメントや変更を加えたり、自分について言及した場合にのみ、自動通知が届きます。
開かれているマージリクエストがコンフリクトのためにマージ不可能になった場合、その作成者にその原因が通知されます。 ユーザーがマージリクエストをパイプラインが成功したら自動的にマージするように設定していた場合、そのユーザーにも通知されます。
メールのフィルタリング
通知メールのメッセージには GitLab 固有のヘッダが含まれています。 これらのヘッダの内容に基づいて通知メールをフィルタリングすることで、通知をよりよく管理することができます。 たとえば、マージリクエストやイシューを割り当てられている特定のプロジェクトのメールをすべてフィルタリングすることができます。
次の表は、GitLab特有のメールヘッダの一覧です:
ヘッダー | 説明 |
---|---|
X-GitLab-Group-Id
| グループのID。 エピックへの通知メールにのみ表示されます。 |
X-GitLab-Group-Path
| エピックへの通知メールにのみ表示されます。 |
X-GitLab-Project
| 通知が属するプロジェクト名。 |
X-GitLab-Project-Id
| プロジェクトのID。 |
X-GitLab-Project-Path
| プロジェクトの道筋。 |
X-GitLab-(Resource)-ID
| 通知の対象となるリソースのID。リソースは、例えば、Issue 、MergeRequest 、Commit 、または他のそのようなリソースであることができます。
|
X-GitLab-Discussion-ID
| コメントの通知メールにおいて、コメントが属するスレッドのID。 |
X-GitLab-Pipeline-Id
| パイプラインの通知メールにおける、通知の対象となるパイプラインのID。 |
X-GitLab-Reply-Key
| Eメールでの返信をサポートするユニークなトークンです。 |
X-GitLab-NotificationReason
| 通知の理由。これはmentioned 、assigned 、またはown_activity のいずれかです。
|
List-Id
| RFC 2919のメーリングリスト識別子でプロジェクトのパスを指定します。 フィルタを使ったメール編成などに便利です。 |
X-GitLab-NotificationReason
X-GitLab-NotificationReason
ヘッダは通知の理由を含みます。値は優先度の高い順に、以下のいずれかです:
own_activity
assigned
mentioned
通知の理由は、通知メールのフッターにも記載されます。例えば、assigned
という理由のメールには、フッターにこのような文章が記載されます:
You are receiving this email because you have been assigned an item on <configured GitLab hostname>.
X-GitLab-NotificationReason
ヘッダーに含めることが検討されています。詳しくは、この関連イシューをご覧ください。