Skip to content

[K9CODESEC-4729] Document the Secret Scanning configuration file - #39313

Open
MikaYuoadas wants to merge 1 commit into
masterfrom
akim.sadaoui/secrets-config-file-docs
Open

[K9CODESEC-4729] Document the Secret Scanning configuration file#39313
MikaYuoadas wants to merge 1 commit into
masterfrom
akim.sadaoui/secrets-config-file-docs

Conversation

@MikaYuoadas

@MikaYuoadas MikaYuoadas commented Aug 19, 2026

Copy link
Copy Markdown

What does this PR do? What is the motivation?

Documents the configuration file for Secret Scanning, and adds schema-version: v1.5 to the Code Security configuration reference.

Secret Scanning gains a configuration file alongside its existing in-app configuration. Rules, scanning groups, and custom rules continue to be configured in Datadog and the config file controls which files are analyzed.

Secret Scanning configuration page

  • Adds a File configuration section covering the secrets.global-config properties: only-paths, ignore-paths, use-gitignore, ignore-generated-files, and max-file-size-kb.
  • Retitles the page from Rule Configuration to Configuration, since it covers both rule and file configuration.

Code Security configuration reference

  • Adds the v1.5 schema version and the secrets section to the version table, the structure example, and the optional-sections list.

Merge readiness

  • Ready for merge

Adds the secrets.global-config fields to the Secret Scanning page and
schema-version v1.5 to the Code Security configuration reference.

Refs: K9CODESEC-4729
@MikaYuoadas
MikaYuoadas requested a review from a team as a code owner August 19, 2026 08:25
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Aug 19, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@maycmlee maycmlee left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great, just a small suggestion!


## File configuration

Rules are configured in Datadog, as described above. Which files Secret Scanning reads is configured under the `secrets` key in the Code Security configuration. Define it in Datadog, or in a `code-security.datadog.yaml` file at the root of your repository.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It's clearer for users to be linked to the specific section.

Suggested change
Rules are configured in Datadog, as described above. Which files Secret Scanning reads is configured under the `secrets` key in the Code Security configuration. Define it in Datadog, or in a `code-security.datadog.yaml` file at the root of your repository.
Rules are configured in Datadog as described in the [Configuring rules](#configuring-rules) section. Which files Secret Scanning reads is configured under the `secrets` key in the Code Security configuration. Define it in Datadog, or in a `code-security.datadog.yaml` file at the root of your repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants