Skip to content

Commit 0c558db

Browse files
Replace references to detect-secrets repo (#110)
* Replace references to detect-secrets repo * Remove uneccessary character * Revert "Remove uneccessary character" This reverts commit 41474a73f639f1a617b34ba71a64fbdfa2197b61. * Move build badge down
1 parent 01af33f commit 0c558db

File tree

5 files changed

+11
-9
lines changed

5 files changed

+11
-9
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Detect Secrets Stream [![Build Status](https://travis-ci.com/IBM/detect-secrets-stream.svg?branch=main)](https://travis-ci.com/IBM/detect-secrets-stream.svg?branch=main)
1+
# Detect Secrets Stream
2+
3+
[![Build Status](https://travis-ci.com/IBM/detect-secrets-stream.svg?branch=main)](https://travis-ci.com/IBM/detect-secrets-stream.svg?branch=main)
24

35
## Description
46

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# scan-worker
2-
A Kubernetes worker that pulls from a Kafka queue and performs a whitewater-detect-secrets scan.
2+
A Kubernetes worker that pulls from a Kafka queue and performs a [detect-secrets](https://github.com/IBM/detect-secrets) scan.
33

44
Adapted from [this Kubernetes tutorial](https://kubernetes.io/docs/tasks/job/fine-parallel-processing-work-queue/) and [this IBM Event Streams code sample](https://github.com/ibm-messaging/event-streams-samples/tree/master/kafka-python-console-sample).

detect_secrets_stream/scan_worker/test_data/diff_files/removed.diff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ index 456100d..dc6b7e2 100644
99
-# Remove the fake gd_db_tools that exists for testing until mono-repo is implemented
1010
-RUN rm -f ./gd_db_tools.py
1111
-
12-
# Copy /whitewater-detect-secrets from builder stage
13-
COPY --from=builder /whitewater-detect-secrets /whitewater-detect-secrets
12+
# Copy /detect-secrets from builder stage
13+
COPY --from=builder /detect-secrets /detect-secrets
1414

1515
diff --git a/diffscanworker_test.py b/diffscanworker_test.py
1616
index 16bb25c..651dfcb 100644

docs/adding-a-new-detector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Adding a new type of detector to detect-secrets-suite is a multi-stage process.
2020

2121
For detailed instructions on developing a new secret detector, see:
2222

23-
- [`IBM/detect-secrets` CONTRIBUTING.md - Process for Adding a New Secret Detector to whitewater-detect-secrets](https://github.com/IBM/detect-secrets/blob/master/CONTRIBUTING.md#process-for-adding-a-new-secret-detector-to-whitewater-detect-secrets)
23+
- [`IBM/detect-secrets` CONTRIBUTING.md - Process for Adding a New Secret Detector to detect-secrets](https://github.com/IBM/detect-secrets/blob/master/CONTRIBUTING.md#process-for-adding-a-new-secret-detector-to-detect-secrets)
2424
- [`IBM/detect-secrets-stream` CONTRIBUTING.md - Process for Supporting a New Secret Type in detect-secrets-stream](../CONTRIBUTING.md#process-for-supporting-a-new-secret-type-in-detect-secrets-stream)
2525

2626
Please open one or more PRs using the instructions above.

kustomize_envs/dev/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# local end 2 end test
22

3-
This doc describes how to use `skaffold` to run a detect-secrets-stream instance in a local kube env and run some end 2 end test.
3+
This document describes how to use [`skaffold`](https://skaffold.dev/docs/references/cli/) to run a detect-secrets-stream instance in a local Kubernetes environment and run some end to end tests.
44

55
## Dependencies
66

@@ -10,11 +10,11 @@ This doc describes how to use `skaffold` to run a detect-secrets-stream instance
1010
- `kustomize_envs/dev/secret_manual/app.key` stores the private key for this test Github App
1111
- `APP_ID` in `kustomize_envs/dev/secret_manual/env.txt` stores the Github App ID
1212
- a kafka queue named `diff-scan`
13-
- You can request a free kafka instance in your own IBM Cloud account. Service link: https://cloud.ibm.com/catalog/services/event-streams. Once created, generate a queue named `diff-scan` in the kafka instance. **TODO** parameterize queue name
13+
- You can request a free Kafka instance in your own IBM Cloud account. The service can be found [here](https://cloud.ibm.com/catalog/services/event-streams). Once created, generate a queue named `diff-scan` in the kafka instance. **TODO** parameterize queue name
1414

1515
### ondemand provision
1616

17-
The resource below would be automatically provisioned when you run skaffold
17+
The resources below will be automatically provisioned when you run [`skaffold`](https://skaffold.dev/docs/references/cli/):
1818

1919
- postgres
2020
- vault
@@ -46,7 +46,7 @@ kind delete cluster
4646

4747
## Execute test
4848

49-
The ingest script reads payload from `kustomize_envs/dev/test/ingest.payload.json`, you can edit that file to customize the payload such as which repo and which commit to ingest.
49+
The ingest script reads payloads from `kustomize_envs/dev/test/ingest.payload.json`; you can edit this file to customize the payload, such as which repo and which commit to ingest.
5050

5151
```shell
5252
# Ingest token by sending payload to ingest layer

0 commit comments

Comments
 (0)