Skip to content

Commit 77008ab

Browse files
eranturgemaneranturgeman
authored
Docs update about recursive scan in 'audit' and frogbot (#85)
1 parent 4f1e8c5 commit 77008ab

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

‎jfrog-applications/frogbot/scan-repositories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Frogbot scans your Git repositories periodically and automatically creates pull
66

77
![](../.gitbook/assets/fix-pr.png)
88

9-
_**NOTE:**_: The pull request fix is presently unavailable for older NuGet projects that use the package.config file instead of the PackageReference syntax.
9+
_**NOTE:**_ The pull request fix is presently unavailable for older NuGet projects that use the package.config file instead of the PackageReference syntax.
1010

1111
#### Adding Security Alerts
1212

‎jfrog-applications/frogbot/templates/.frogbot/frogbot-config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
# - installCommand: ""
7878

7979
# [Default: root directory]
80-
# List of relative path's to the projects directories in the git repository
80+
# List of relative path's to the projects directories in the git repository. If left empty (without providing "." yourself as the root directory's path), a recursive scan is triggered from the root directory of the project.
8181
# workingDirs:
8282
# - "."
8383

‎jfrog-applications/frogbot/templates/github-actions/frogbot-scan-pull-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ jobs:
8080
# JF_INSTALL_DEPS_CMD: ""
8181

8282
# [Optional, default: "."]
83-
# Relative path to the root of the project in the Git repository
83+
# Relative path to the root of the project in the Git repository. If left empty (without providing "." yourself as default), a recursive scan is triggered from the root directory of the project.
8484
# JF_WORKING_DIR: path/to/project/dir
8585

8686
# [Default: "*git*;*node_modules*;*target*;*venv*;*test*"]

‎jfrog-applications/frogbot/templates/github-actions/frogbot-scan-repository.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ jobs:
6868
##########################################################################
6969

7070
# [Optional, default: "."]
71-
# Relative path to the root of the project in the Git repository
71+
# Relative path to the root of the project in the Git repository. If left empty (without providing "." yourself as default), a recursive scan is triggered from the root directory of the project.
7272
# JF_WORKING_DIR: path/to/project/dir
7373

7474
# [Default: "*git*;*node_modules*;*target*;*venv*;*test*"]

‎jfrog-applications/jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu
3535
#### Commands Params
3636

3737
| | |
38-
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
38+
| --------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3939
| **Command name** | audit |
4040
| **Abbreviation** | aud |
4141
| **Command options** | |
@@ -50,7 +50,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu
5050
| --dep-type | <p>[Default: all] [npm]<br><br>Defines npm dependencies type. Possible values are: all, devOnly and prodOnly</p> |
5151
| --exclude-test-deps | <p>[Default: false] [Gradle]<br><br>Set to true if you'd like to exclude Gradle test dependencies from Xray scanning.</p> |
5252
| --requirements-file | <p>[Optional] [Pip]<br><br>Defines pip requirements file name. For example: 'requirements.txt'</p> |
53-
| --working-dirs | <p>[Optional]<br><br>A comma-separated list of relative working directories, to determine the audit targets locations.</p> |
53+
| --working-dirs | <p>[Optional]<br><br>A comma-separated list of relative working directories, to determine the audit targets locations.</p> If flag isn't provided, a recursive scan is triggered from the root directory of the project. |
5454
| --exclusions | <p>[Default: *.git*;*node_modules*;*target*;*venv*;*test*]<br><br>List of exclusions separated by semicolons, utilized to skip sub-projects from undergoing an audit. These exclusions may incorporate the * and ? wildcards.</p> |
5555
| --fixable-only | <p>[Optional]<br><br>Set to true if you wish to display issues that have a fix version only.</p> |
5656
| --min-severity | <p>[Optional]<br><br>Set the minimum severity of issues to display. The following values are accepted: Low, Medium, High or Critical</p> |

0 commit comments

Comments
 (0)