Skip to content

Document comments.disabled YAML field for Code Coverage#37023

Merged
nikita-tkachenko-datadog merged 7 commits into
masterfrom
nikita.tkachenko/code-coverage-yaml-disable-comments
May 27, 2026
Merged

Document comments.disabled YAML field for Code Coverage#37023
nikita-tkachenko-datadog merged 7 commits into
masterfrom
nikita.tkachenko/code-coverage-yaml-disable-comments

Conversation

@nikita-tkachenko-datadog
Copy link
Copy Markdown
Contributor

@nikita-tkachenko-datadog nikita-tkachenko-datadog commented May 27, 2026

What does this PR do? What is the motivation?

Adds a "PR comments" section to the Code Coverage Configuration page documenting the new `comments.disabled` YAML field. When set to `true`, Datadog stops adding the Code Coverage section to the pull request summary comment; PR Gate checks continue to evaluate and report as commit checks.

Also updates the top-level example configuration on the page to surface the new field for discoverability (with the explicit default value `false`).

The backing implementation lives in DataDog/dd-source#449253.

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

Page preview: the new section appears between "PR Gates" and "Carryforward".

nikita-tkachenko-datadog and others added 5 commits May 27, 2026 10:01
Adds a "PR comments" section to the Code Coverage configuration page
explaining how to opt out of Code Coverage PR comments via the new
`comments.disabled` field, while keeping PR Gate checks active.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Datadog updates a single coverage summary on the PR rather than posting one
comment per upload; reword to reflect that without adding extra detail.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Rename heading to "PR Comments", drop the small example, the field reference,
and the redundant explanation. Note that gates are unaffected by the setting.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

Use "summary comment" to match the section heading, drop the gates block
from the example (unrelated to comments), and inline the snippet like the
Carryforward section does.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@nikita-tkachenko-datadog nikita-tkachenko-datadog marked this pull request as ready for review May 27, 2026 10:18
@nikita-tkachenko-datadog nikita-tkachenko-datadog requested a review from a team as a code owner May 27, 2026 10:18
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@nikita-tkachenko-datadog nikita-tkachenko-datadog merged commit f30b187 into master May 27, 2026
19 checks passed
@nikita-tkachenko-datadog nikita-tkachenko-datadog deleted the nikita.tkachenko/code-coverage-yaml-disable-comments branch May 27, 2026 17:28
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.

2 participants