File tree Expand file tree Collapse file tree 1 file changed +14
-0
lines changed
Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Original file line number Diff line number Diff line change 1515 * [ Benchmark] ( #benchmark )
1616 * [ Main Requirements] ( #main-requirements )
1717 * [ Installation] ( #installation )
18+ * [ How to extend the dataset] ( #how-to-extend-the-dataset )
1819 * [ How to run] ( #how-to-run )
1920 * [ Benchmark Result] ( #benchmark-result )
2021 * [ Used Tools for Benchmarking] ( #used-tools-for-benchmarking )
@@ -265,6 +266,19 @@ $ source venv/bin/activate
265266$ pip install -qr requirements.txt
266267```
267268
269+ ### How to extend the dataset
270+
271+ 1 . Find an interesting repo and commit
272+ 2 . add to snapshot.json the data:
273+ ``` json
274+ "{commit_hash}{any_padding_hex_symbols_to_64}" : " https://github.com/org/repo" ,
275+ ```
276+ 3 . run download_data.py twice (first - a meta file will be created, second - all files from the commit will be downloaded)
277+ 4 . run CredSweeper for the downloaded data to obtain a report (preferred with ``--ml_threshold 0`` argument)
278+ 5 . run benchmark for the report with ``--fix`` option - all found values will be inserted into meta
279+ 6 . review, correct markup if necessary, produce empty benchmark report for CI, commit the changes
280+
281+
268282### How to run
269283``` bash
270284usage: python -m benchmark [-h] --scanner [SCANNER]
You can’t perform that action at this time.
0 commit comments