Skip to content

Add documentation for code-security.datadog.yaml configuration file#852

Merged
jasonforal merged 1 commit intomainfrom
jf/K9VULN-11777
Mar 20, 2026
Merged

Add documentation for code-security.datadog.yaml configuration file#852
jasonforal merged 1 commit intomainfrom
jf/K9VULN-11777

Conversation

@jasonforal
Copy link
Copy Markdown
Collaborator

@jasonforal jasonforal commented Mar 16, 2026

What this PR docs

  • Syncs the README.md documentation of the configuration schema with official Datadog docs.

Notes

@datadog-prod-us1-4
Copy link
Copy Markdown

datadog-prod-us1-4 Bot commented Mar 16, 2026

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 85.01% (+0.00%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 9bb7576 | Docs | Datadog PR Page | Was this helpful? React with 👍/👎 or give us feedback!

@jasonforal jasonforal changed the base branch from main to jf/K9VULN-11777-1 March 19, 2026 21:52
Base automatically changed from jf/K9VULN-11777-1 to main March 19, 2026 21:54
@jasonforal jasonforal force-pushed the jf/K9VULN-11777 branch 2 times, most recently from 896dbe2 to b91b27d Compare March 20, 2026 13:44
Copilot AI review requested due to automatic review settings March 20, 2026 13:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates repository documentation to reflect the new code-security.datadog.yaml configuration file format (while still acknowledging the legacy static-analysis.datadog.yml where needed, e.g., for IDE extensions).

Changes:

  • Update user-facing docs to reference code-security.datadog.yaml instead of the legacy static-analysis.datadog.yml.
  • Replace legacy configuration examples with schema-version: v1.0 + sast:-scoped examples.
  • Update schema-validation instructions to point to the schema/sast/v1.0 JSON schema artifacts.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
doc/report-issue.md Updates bug-report instructions to request the new config file (with legacy fallback).
doc/owasp-benchmark.md Updates OWASP benchmark setup instructions to use the new config schema/shape.
README.md Rewrites the configuration section to document the code-security.datadog.yaml / sast schema, including examples and schema validation instructions.
FAQ.md Updates the “generated files” FAQ example to the new config format under sast.global-config.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread FAQ.md Outdated
juli1
juli1 previously approved these changes Mar 20, 2026
@jasonforal jasonforal merged commit 6a28670 into main Mar 20, 2026
88 checks passed
@jasonforal jasonforal deleted the jf/K9VULN-11777 branch March 20, 2026 18:42
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.

3 participants