Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flaky test notifications and webhook configuration #1419

Merged
merged 2 commits into from Mar 28, 2024

Conversation

ralopes
Copy link
Collaborator

@ralopes ralopes commented Mar 28, 2024

Adds documentation on how to enable and set up webhook notifications for flaky test detection. It includes steps to follow and the schema of the notification payload received by the endpoint.
localhost_8000_essentials_flaky-tests_

Adds documentation on how to enable and set up webhook notifications for flaky test detection. It includes steps to follow and the schema of the notification payload received by the endpoint.
@ralopes ralopes marked this pull request as ready for review March 28, 2024 13:14
@ralopes ralopes requested a review from skipi March 28, 2024 13:15
@ralopes ralopes self-assigned this Mar 28, 2024
docs/essentials/flaky-tests.md Outdated Show resolved Hide resolved
…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.
@ralopes ralopes requested a review from radwo March 28, 2024 17:18
@ralopes ralopes merged commit 87f707e into master Mar 28, 2024
1 check passed
@ralopes ralopes deleted the rl/update-flaky-test branch March 28, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants