Skip to content

Commit

Permalink
Refactor flaky tests documentation to clarify branch configuration an…
Browse files Browse the repository at this point in the history
…d notification payload

Refactor flaky tests documentation to provide clearer instructions on configuring branches and understanding the notification payload. Specifically, the changes include:

- Clarifying that basic regular expressions can be used in the branches field.
- Providing examples of using regular expression patterns like `release-*` or `.*`.
- Noting the character limit of 100 for the branches field.
- Suggesting comma separation for specifying multiple branches.
- Describing the expected schema of the notification payload.
- Highlighting that the Content-Type header of the HTTP POST request is set to application/json.
- Emphasizing the expected status code range for the response from the endpoint.
- Mentioning the retry mechanism employed when a response is outside the 200 range.

These modifications aim to enhance the clarity and ease of understanding for users working with flaky test configurations and handling notifications.
  • Loading branch information
ralopes committed Mar 28, 2024
1 parent 28baa67 commit b9494a4
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/essentials/flaky-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,14 +189,18 @@ To enable notifications, follow these steps on the Flaky Tests page:
5. Click on Activate and Save.

!!! info "Branches"
We support simple regular expressions in the branches field, you can for example use release-* or .*
There's a limit of 100 characters allowed in the branches field.
We allow basic regular expressions in the branches field. For instance, you can use patterns like `release-*` or `.*`.
Please note that there's a character limit of 100 for the branches field. If you wish to specify multiple branches, you can separate them using a comma.

![notifications](img/flaky-tests/notifications.png)

#### Notification payload

Your endpoint will receive an HTTP POST with the following schema. Your endpoint should respond with a status code in the 200 range.
Your endpoint is set to receive an HTTP POST request with a specific schema.
This request will have the Content-Type header set to application/json.
It is expected that your endpoint responds with a status code within the 200 range.
If the response status code is outside this range, we will attempt to resend the request four additional times,
employing an exponential backoff strategy for these retries.

```spec
type: object
Expand Down

0 comments on commit b9494a4

Please sign in to comment.