Document SecretParts contract in detector-authoring docs#4912
Open
mcastorina wants to merge 1 commit intosecret-parts-rename-draftfrom
Open
Document SecretParts contract in detector-authoring docs#4912mcastorina wants to merge 1 commit intosecret-parts-rename-draftfrom
mcastorina wants to merge 1 commit intosecret-parts-rename-draftfrom
Conversation
Adds a "Populating SecretParts" section to both the external and internal detector-authoring guides. Covers what SecretParts is, the rule that every Result must populate it, and the shape for single-part vs multi-part credentials with code examples. Establishes "key" as the convention for single-part detectors (matches ~48 existing detectors vs ~13 using "token").
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Populating SecretParts section to hack/docs/Adding_Detectors_Internal.md and hack/docs/Adding_Detectors_external.md. Covers: what SecretParts is, the always-populate rule, single-part vs multi-part shape with Go examples, and the observed "key" naming convention for single-part detectors (~48 uses vs ~13 "token" on the rename branch).
Note
Low Risk
Documentation-only changes that clarify how detectors must populate
SecretParts; no runtime or API behavior changes.Overview
Adds a new "Populating
SecretParts" section to both internal and external detector-authoring docs, definingSecretPartsas the required structured source of credential components.Updates the detector creation checklists to require always populating
Result.SecretParts(verified or not), with guidance and Go examples for single-part ("key") vs multi-part credentials and key-naming conventions.Reviewed by Cursor Bugbot for commit 83c72c4. Bugbot is set up for automated code reviews on this repo. Configure here.