Flaky Tests Policies [DOCS-10820] #30887
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
Preview links (active after the
|
KickingTheTV
reviewed
Aug 4, 2025
KickingTheTV
reviewed
Aug 4, 2025
KickingTheTV
reviewed
Aug 4, 2025
KickingTheTV
requested changes
Aug 4, 2025
|
Created this docs review card: https://datadoghq.atlassian.net/browse/DOCS-11727 |
Co-authored-by: Bryan Lee <[email protected]>
maycmlee
approved these changes
Aug 5, 2025
|
|
||
| | Action | Description | | ||
| | ---- | ---- | | ||
| | **Quarantine** | Toggle to allow flaky tests to be quarantined for this repository. Customize automation rules based on: <li>Time: Quarantine a test if its status is Active for a specified number of days. <li>Branch: Quarantine an Active test if it flakes in one or more specified branches.| |
There was a problem hiding this comment.
For consistency with the rest of the document where statuses use inline code
Suggested change
| | **Quarantine** | Toggle to allow flaky tests to be quarantined for this repository. Customize automation rules based on: <li>Time: Quarantine a test if its status is Active for a specified number of days. <li>Branch: Quarantine an Active test if it flakes in one or more specified branches.| | |
| | **Quarantine** | Toggle to allow flaky tests to be quarantined for this repository. Customize automation rules based on: <li>Time: Quarantine a test if its status is `Active` for a specified number of days. <li>Branch: `Quarantine` an `Active` test if it flakes in one or more specified branches.| |
| | Action | Description | | ||
| | ---- | ---- | | ||
| | **Quarantine** | Toggle to allow flaky tests to be quarantined for this repository. Customize automation rules based on: <li>Time: Quarantine a test if its status is Active for a specified number of days. <li>Branch: Quarantine an Active test if it flakes in one or more specified branches.| | ||
| | **Disable** | Toggle to allow flaky tests to be disabled for this repository. You may want to do this after quarantining or to protect specific branches from flakiness. Customize automation rules based on: <li>Status and time: Disable a test if it has a specified status for a specified number of days. <li>Branch: Disable an Active or Quarantined test if it flakes in one or more specified branches. | |
There was a problem hiding this comment.
Suggested change
| | **Disable** | Toggle to allow flaky tests to be disabled for this repository. You may want to do this after quarantining or to protect specific branches from flakiness. Customize automation rules based on: <li>Status and time: Disable a test if it has a specified status for a specified number of days. <li>Branch: Disable an Active or Quarantined test if it flakes in one or more specified branches. | | |
| | **Disable** | Toggle to allow flaky tests to be disabled for this repository. You may want to do this after quarantining or to protect specific branches from flakiness. Customize automation rules based on: <li>Status and time: Disable a test if it has a specified status for a specified number of days. <li>Branch: Disable an `Active` or `Quarantined` test if it flakes in one or more specified branches. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Adds new section and image for Flaky Tests Policies. Added to existing Flaky Test Management docs to minimize having the reader jump around to a separate docs page.
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes