Skip to content

Commit 60b47ce

Browse files
committed
CM-41217 Update Readme
Update README.md
1 parent 5505186 commit 60b47ce

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ This guide will guide you through both installation and usage.
3030
6. [Commit History Scan](#commit-history-scan)
3131
1. [Commit Range Option](#commit-range-option)
3232
7. [Pre-Commit Scan](#pre-commit-scan)
33+
8. [Lock Restore Options](#lock-restore-options)
34+
1. [SBT Scan](#sbt-scan)
3335
2. [Scan Results](#scan-results)
3436
1. [Show/Hide Secrets](#showhide-secrets)
3537
2. [Soft Fail](#soft-fail)
@@ -496,6 +498,17 @@ After your install the pre-commit hook and, you may, on occasion, wish to skip s
496498
497499
`SKIP=cycode git commit -m <your commit message>`
498500
501+
### Lock Restore Options
502+
503+
#### SBT Scan
504+
505+
We use sbt-dependency-lock plugin to restore the lock file for SBT projects.
506+
To disable lock restore in use `--no-restore` option.
507+
508+
Prerequisites
509+
* sbt-dependency-lock Plugin: Install the plugin by adding the following line to `project/plugins.sbt`:
510+
`addSbtPlugin("software.purpledragon" % "sbt-dependency-lock" % "1.5.1")`
511+
499512
## Scan Results
500513
501514
Each scan will complete with a message stating if any issues were found or not.

0 commit comments

Comments
 (0)