Skip to content

Dokumentacja referencyjna

Powiadomienia

Przebieg zakończony powodzeniem nikogo nie powiadamia. Gdy Oloproof wysyła powiadomienie, oznacza to, że coś wymaga decyzji albo zaraz przestanie działać: wydanie zablokowane przez bramkę, zakończony przebieg zarządzany, wyczerpujący się limit.

Powiadomienia są wyłącznie e-mailowe. Nie ma Slacka, pagera ani webhooka, a żadna reguła dla całego obszaru roboczego nie decyduje, kto o czym się dowiaduje: każdy członek sam włącza lub wyłącza każdy rodzaj dla siebie.

Co do Ciebie trafia

W hostowanym obszarze roboczym cztery rodzaje wiadomości e-mail:

  • Zablokowane wydania: przebieg lub porównanie wysłane do projektu, do którego należysz, ma

bramkę blokującą wydanie. Wiadomość wymienia każdy wynik i decyzję każdej reguły, tak jak zapisał je silnik, i zawiera link do wyniku. Domyślnie wyłączone dla roli Reviewer.

  • Przebiegi zarządzane: przebieg uruchomiony przez oloproof run --cloud zakończył się lub nie

powiódł. Trafia do ról Owner, Admin i Member obszaru roboczego, ponieważ przebieg zarządzany nie zapisuje, kto go uruchomił.

  • Zużycie: obszar roboczy, którego jesteś właścicielem, wykorzystał 80% lub całość swojego

miesięcznego limitu. Raz na próg w miesiącu.

  • Nowi członkowie: ktoś dołączył do obszaru roboczego, którego jesteś właścicielem lub

administratorem.

Kilka zablokowanych wydań lub zakończonych przebiegów w jednym projekcie w ciągu piętnastu minut przychodzi jako jedna wiadomość. Żadna wiadomość nie zawiera treści przypadku.

Każda wiadomość kończy się linkiem, który wyłącza dany rodzaj wiadomości, a własny przycisk rezygnacji z subskrypcji w programie pocztowym robi to samo bez otwierania strony. Wszystkie cztery rodzaje można włączyć lub wyłączyć na stronie konta.

Lokalny workbench nie wysyła żadnych wiadomości e-mail.

Co do Ciebie trafia bez e-maila

Zablokowana bramka powoduje niepowodzenie zadania, które ją uruchomiło. oloproof run, oloproof gate i oloproof compare kończą działanie z kodem bramki, więc kontrola pull requestu zmienia kolor na czerwony, a dostawca CI powiadamia tych, których zwykle powiadamia o nieudanych zadaniach.

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

Co jest planowane

  • Reguły obszaru roboczego: które zdarzenia powiadamiają, którymi kanałami i w jakim czasie.
  • Godziny ciszy: w nocy nic nie jest wysyłane, z wyjątkiem decyzji o wstrzymaniu wydania, która

przebija się mimo to.

  • Kanały: Slack i podpisany webhook.

Dopóki ich nie ma, ekran Alerts w workbenchu mówi to samo.