Skip to content

リファレンス

通知

合格した実行は誰にも通知しません。Oloproof が通知を送るとき、それは何かが判断を必要としているか、何かが間もなく機能しなくなることを意味します。ゲートがブロックしたリリース、終了したマネージド実行、残り少なくなった利用枠などです。

通知はメールのみです。Slack、ページャー、webhook はなく、誰が何を受け取るかをワークスペース全体のルールで決めることもありません。各メンバーが、種類ごとに自分で通知をオンまたはオフにします。

届くもの

ホスト型のワークスペースでは、4 種類のメールが届きます。

  • ブロックされたリリース: あなたが所属するプロジェクトにプッシュされた実行または比較で、ゲートがリリースをブロックしました。メールには、エンジンが記録したとおりに各結果と各ルールの判定が記載され、結果へのリンクが付きます。Reviewer ではデフォルトでオフです。
  • マネージド実行: oloproof run --cloud で送信された実行が完了または失敗しました。マネージド実行は誰が送信したかを記録しないため、このメールはワークスペースの Owner、Admin、Member に送られます。
  • 使用量: あなたが所有するワークスペースが、月間利用枠の 80% またはすべてを使用しました。しきい値ごとに月 1 回送られます。
  • 新しいメンバー: あなたが所有または管理するワークスペースに誰かが参加しました。

1 つのプロジェクトで 15 分以内に発生した複数のブロックされたリリースや終了した実行は、1 通のメールにまとめて届きます。ケースの内容を含むメールはありません。

どのメールも、その種類のメールを停止するリンクで終わります。メールクライアント自体の配信停止ボタンでも、ページを開かずに同じことができます。4 種類すべてを、アカウントページからオンまたはオフにできます。

ローカルのワークベンチはメールを送信しません。

メール以外で届くもの

ブロックされたゲートは、それを実行したジョブを失敗させます。oloproof run、oloproof gate、oloproof compare はいずれもゲートのコードで終了するため、プルリクエストのチェックは赤になり、CI プロバイダーが失敗したジョブについて通知する相手に通知します。

oloproof gate RUN_ID --policy release.yaml
echo $?   # 3 when the gate blocks

計画されているもの

  • ワークスペースのルール: どのイベントを、どのチャネルで、どのタイミングで通知するか。
  • 通知停止時間帯: 夜間は何も送信されません。ただし、リリース停止の通知だけはこれを突破して送られます。
  • チャネル: Slack と署名付き webhook。

これらが存在するまでは、ワークベンチの Alerts 画面が同じことを伝えます。