Skip to content

Add documentation for custom Secret Detection rule format

What does this MR do and why?

This MR adds documentation for the custom rule format used in Secret Detection, specifically explaining:

  • The supported fields in custom rules, including GitLab-specific fields title and remediation
  • How custom rules with matching IDs override extended rules
  • Example TOML configurations showing proper rule format

This documentation helps users understand how to create and customize their Secret Detection rules, particularly when using the recently added title and remediation fields.

References

Please include cross links to any resources that are relevant to this MR. This will give reviewers and future readers helpful context to give an efficient review of the changes introduced.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Merge request reports

Loading