From b2591916dbbcb814c366f61dcf75a1d50c9e6764 Mon Sep 17 00:00:00 2001 From: andream16 Date: Tue, 17 Sep 2024 17:03:46 +0100 Subject: [PATCH] Fixing formatting issues on markdown files --- components/enrichers/reachability/README.md | 20 ++++++++++--------- .../reachability/test/testdata/README.md | 12 +++++------ 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/components/enrichers/reachability/README.md b/components/enrichers/reachability/README.md index e581911ba..781c35a6b 100644 --- a/components/enrichers/reachability/README.md +++ b/components/enrichers/reachability/README.md @@ -1,6 +1,6 @@ # Reachability -This enricher performs reachability analysis +This enricher performs reachability analysis using [atom](https://github.com/AppThreat/atom). It enriches the raw results in input, for example @@ -11,16 +11,18 @@ to be set as the mechanism to generate the reports are different based on programming language. ## Environment variables -- `READ_PATH`: specifies the location from where to look for raw reports. -- `WRITE_PATH`: specifies the location where to write enriched results. -- `ATOM_FILE_PATH`: specifies the location where to find -the atom file with a reachability report. + +* `READ_PATH`: specifies the location from where to look for raw reports. +* `WRITE_PATH`: specifies the location where to write enriched results. +* `ATOM_FILE_PATH`: specifies the location where to find + the atom file with a reachability report. ## Limitations -- Right now the enricher requires a file called `bom.json` -to be produced by [cdxgen](https://github.com/CycloneDX/cdxgen) -to be present in the directory where the cloned repository -is located. + +* Right now the enricher requires a file called `bom.json` + to be produced by [cdxgen](https://github.com/CycloneDX/cdxgen) + to be present in the directory where the cloned repository + is located. ## Examples diff --git a/components/enrichers/reachability/test/testdata/README.md b/components/enrichers/reachability/test/testdata/README.md index 6e28d0fd8..2423a140c 100644 --- a/components/enrichers/reachability/test/testdata/README.md +++ b/components/enrichers/reachability/test/testdata/README.md @@ -9,18 +9,18 @@ for example [fportantier/vulpy](https://github.com/fportantier/vulpy). 1. Checkout [bandit](https://github.com/PyCQA/bandit). 2. Get a bandit report in json format: -`bandit -r $directory --format json --output out.json`. -`$directory` is where you cloned the repository with vulnerabilities. -3. Get `/producer/python-bandit` to read in input `out.json` -and in output `out.tagged.pb`. + `bandit -r $directory --format json --output out.json`. + `$directory` is where you cloned the repository with vulnerabilities. +3. Get `/producer/python-bandit` to read in input `out.json` + and in output `out.tagged.pb`. ### pip-safety.tagged.pb 1. Checkout [safety](https://pypi.org/project/safety/) 2. Get a safety report in json format: -`safety check -r requirements.txt --save-json out.json` + `safety check -r requirements.txt --save-json out.json` 3. Get `producer/python-pip-safety` to read in input `out.json` -and in output `pip-safety.tagged.pb` + and in output `pip-safety.tagged.pb` ### reachables.json