Teams

A repository can contain thousands of tests, and maybe your team only owns few of them. In this case, you can set up which tests you would like to receive notifications for in case they break.

If you prefer not to setup teams and instead setup a generic notification that will fire on any test breakage, see section below.

NOTE: even if you setup teams, we always suggest to setup the generic notification, otherwise if a test break and does not match any team regex, we will not send out a notification!

Configuring teams

You can do this with the notifications settings.

Example:

notifications:
    # Required: team name
  - name: testpulse-devs
    
    # Required: List of regex that matches test qualified paths
    paths:
        - io.testpulse.app.*
        - io.testpulse.something.*
    
    # Optional: List of regex that you want to exclude from the previous list
    exclude_paths:
        - io.testpulse.something.package_i_dont_want.*

More in details:

  • name (required): unique identifier for the team. You should put the same team name you specified in GitHub, otherwise Issues creation will not work properly.
  • paths (required): list of regex that matches test paths. The team will receive a notification any time a test that matches any of the provided regex break.
  • excluded_paths (optional): list of regex that matches test paths. If a test break and it matches one of the paths provided in paths, but it also matches one of the excluded paths, the notification will not be sent. This settings is useful if, for example, you want to receive notifications for an entire package except 1 file. In this case you can specify the package in paths, and the excluded file in excluded_paths.

Generic notification

When a test does not match any team regex (or you did not set them up), we can still send out a notification if you specify a Slack/Email in the generic settings.

You can specify this in the settings element:

settings:
  - slack_channel: <slack_channel>
  - emails: <email@email.com>

Check the docs to see how to setup Slack and Emails.