Repository navigation
Document test automation exclusion annotations - #40827
calvinbayer wants to merge 4 commits into
Conversation
Preview links (active after the
|
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
There was a problem hiding this comment.
The guide omits minimum Datadog SDK versions for the new annotation APIs, leaving existing users unable to determine whether the examples are supported.
🤖 Bits Code Review · Commit ba50cb9
There was a problem hiding this comment.
More details
The guide explicitly marks all three annotation APIs as unreleased, avoiding unsupported compatibility claims. SDK runtime behavior and full Hugo rendering remain unverified.
🤖 Bits Code Review · Commit a9beae3
|
Thanks for the the PR! Created editorial Jira ticket DOCS-16061 so someone on the docs team can take a look soon. |
|
@autotest Review |
There was a problem hiding this comment.
More details
The guide explicitly requires development SDK builds because the annotation APIs are unreleased. SDK execution behavior and full-site rendering remain independently unverified.
🤖 Bits Code Review · Commit f710b53
|
@autotest Review |
There was a problem hiding this comment.
More details
The guide explicitly marks the annotation APIs as unreleased and requires compatible development builds. The completed static review found no actionable defects, though SDK execution behavior and full-site rendering remain unverified.
🤖 Bits Code Review · Commit 2b53be3
2b53be3 to
caeb3b9
Compare
|
@autotest Review |
There was a problem hiding this comment.
More details
The guide explicitly limits the annotation APIs to unreleased SDK development builds and documents framework-specific restrictions. SDK runtime compatibility remains unverified.
🤖 Bits Code Review · Commit caeb3b9
2 participants
What does this PR do? What is the motivation?
Documents code annotations for protecting individual tests from Datadog failure suppression and automatic retries. Adds JavaScript/TypeScript, Java, and Python usage sections with framework-specific examples and limits, and links the guide from Flaky Tests Management, Auto Test Retries, Early Flake Detection, and the guides index.
Merge readiness
AI assistance
Codex drafted the changes and checked the examples and behavior against the SDK implementations.
For Datadog employees:
<name>/<description>convention.Additional notes
Confirm the corresponding SDK releases and minimum supported versions before merging this PR. Related implementation stacks: JavaScript, Java, and pytest.
Validation: no Vale alerts on new content; existing alerts are outside changed lines. YAML and Markdown parse for all five pages, all ten guide links resolve locally, JavaScript examples pass Node syntax checks, and the Python example passes AST parsing. Java examples were checked against the public APIs. Repository staged-content hooks and whitespace checks pass. A full Hugo site build was not run.