Skip to content

Commit 330e02d

Browse files
authored
updated defaults.go references (#4344)
1 parent b484b9e commit 330e02d

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

hack/docs/Adding_Detectors_Internal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Note: Be sure to update the tests to reference the new secret values in GSM, or
5757

5858
3. Add a 'version' field in ExtraData for both existing and new detector versions.
5959

60-
4. Update the existing detector in DefaultDetectors in `/pkg/engine/defaults.go`
60+
4. Update the existing detector in DefaultDetectors in `/pkg/engine/defaults/defaults.go`
6161

6262
5. Proceed from step 3 of [Creating a new Secret Scanner](#creating-a-new-secret-scanner)
6363

@@ -87,7 +87,7 @@ Note: Be sure to update the tests to reference the new secret values in GSM, or
8787
4. Found and unverified (indeterminately due to an unexpected API response)
8888
5. Not found
8989
6. Any false positive cases that you come across
90-
5. Add your new detector to DefaultDetectors in `/pkg/engine/defaults.go`
90+
5. Add your new detector to DefaultDetectors in `/pkg/engine/defaults/defaults.go`
9191
6. Create a merge request for review. CI tests must be passing.
9292

9393
## Addendum

hack/docs/Adding_Detectors_external.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Note: Be sure to update the tests to reference the new secret values in GSM, or
5353

5454
3. Add a 'version' field in ExtraData for both existing and new detector versions.
5555

56-
4. Update the existing detector in DefaultDetectors in `/pkg/engine/defaults.go`
56+
4. Update the existing detector in DefaultDetectors in `/pkg/engine/defaults/defaults.go`
5757

5858
5. Proceed from step 3 of [Creating a new Secret Scanner](#creating-a-new-secret-scanner)
5959

@@ -71,8 +71,8 @@ Note: Be sure to update the tests to reference the new secret values in GSM, or
7171
```
7272
4. Add the Secret Detector to TruffleHog's Default Detectors
7373

74-
Add the secret scanner to the [`pkg/engine/defaults.go`](https://github.com/trufflesecurity/trufflehog/blob/main/pkg/engine/defaults.go) file like [`github.com/trufflesecurity/trufflehog/v3/pkg/detectors/<detector_name>`](https://github.com/trufflesecurity/trufflehog/blob/b71ea27a696bdf1c3141f637fda4ee4936c2f2d6/pkg/engine/defaults.go#L9) and
75-
[`<detector_name>.Scanner{}`](https://github.com/trufflesecurity/trufflehog/blob/b71ea27a696bdf1c3141f637fda4ee4936c2f2d6/pkg/engine/defaults.go#L1546)
74+
Add the secret scanner to the [`pkg/engine/defaults/defaults.go`](https://github.com/trufflesecurity/trufflehog/blob/main/pkg/engine/defaults/defaults.go) file like [`github.com/trufflesecurity/trufflehog/v3/pkg/detectors/<detector_name>`](https://github.com/trufflesecurity/trufflehog/blob/b71ea27a696bdf1c3141f637fda4ee4936c2f2d6/pkg/engine/defaults/defaults.go#L9) and
75+
[`<detector_name>.Scanner{}`](https://github.com/trufflesecurity/trufflehog/blob/b71ea27a696bdf1c3141f637fda4ee4936c2f2d6/pkg/engine/defaults/defaults.go#L1546)
7676

7777
5. Complete the Secret Detector.
7878

@@ -83,7 +83,7 @@ Note: Be sure to update the tests to reference the new secret values in GSM, or
8383
2. Update the verifier code to use a non-destructive API call that can determine whether the secret is valid or not.
8484
* Make sure you understand [verification indeterminacy](#verification-indeterminacy).
8585
3. Create a [test for the detector](#testing-the-detector).
86-
4. Add your new detector to DefaultDetectors in `/pkg/engine/defaults.go`.
86+
4. Add your new detector to DefaultDetectors in `/pkg/engine/defaults/defaults.go`.
8787
5. Create a pull request for review.
8888

8989
### Testing the Detector

0 commit comments

Comments
 (0)