Skip to content
Sign inGet started

Reference

Notifications

A passing run notifies nobody. When Oloproof sends a notification it means that something needs a decision or is about to stop working: a release a gate blocked, a managed run that ended, an allowance running out.

Notifications are email only. There is no Slack, pager or webhook, and no workspace-wide rule decides who hears what: each member turns each kind on or off for themselves.

What reaches you

On a hosted workspace, four kinds of email:

  • Blocked releases: A run or comparison pushed to a project you belong to has a gate that blocks

a release. The email names each result and each rule's decision, as the engine recorded them, and links to the result. Off by default for a Reviewer.

  • Managed runs: A run submitted with oloproof run --cloud finished or failed. It goes to the

workspace's Owners, Admins and Members, because a managed run does not record who submitted it.

  • Usage: A workspace you own has used 80% or all of its monthly allowance. Once per threshold per

month.

  • New members: Somebody joined a workspace you own or administer.

Several blocked releases or ended runs in one project within fifteen minutes arrive as one email. No email carries a case's content.

Every email ends with a link that stops that kind of email, and your mail client's own unsubscribe button does the same without opening a page. All four can be turned on or off from your account page.

A local workbench sends no email.

What reaches you without email

A blocked gate fails the job that ran it. oloproof run, oloproof gate and oloproof compare all exit with the gate's code, so a pull request check turns red and your CI provider tells whoever it tells about failed jobs.

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

What is planned

  • Workspace rules: Which events notify, on which channels, with what timing.
  • Quiet hours: Nothing is sent overnight except a do-not-ship, which breaks through.
  • Channels: Slack and a signed webhook.

Until they exist, the workbench's Alerts screen says the same thing.