Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update about recursive scan in 'audit' and frogbot #85

Merged
merged 2 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion jfrog-applications/frogbot/scan-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Frogbot scans your Git repositories periodically and automatically creates pull

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

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

#### Adding Security Alerts

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
# - installCommand: ""

# [Default: root directory]
# List of relative path's to the projects directories in the git repository
# 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.
# workingDirs:
# - "."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:
# JF_INSTALL_DEPS_CMD: ""

# [Optional, default: "."]
# Relative path to the root of the project in the Git repository
# 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.
# JF_WORKING_DIR: path/to/project/dir

# [Default: "*git*;*node_modules*;*target*;*venv*;*test*"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ jobs:
##########################################################################

# [Optional, default: "."]
# Relative path to the root of the project in the Git repository
# 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.
# JF_WORKING_DIR: path/to/project/dir

# [Default: "*git*;*node_modules*;*target*;*venv*;*test*"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu
#### Commands Params

| | |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Command name** | audit |
| **Abbreviation** | aud |
| **Command options** | |
Expand All @@ -50,7 +50,7 @@ This command also supports the following Advanced Scans with the **Advanced Secu
| --dep-type | <p>[Default: all] [npm]<br><br>Defines npm dependencies type. Possible values are: all, devOnly and prodOnly</p> |
| --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> |
| --requirements-file | <p>[Optional] [Pip]<br><br>Defines pip requirements file name. For example: 'requirements.txt'</p> |
| --working-dirs | <p>[Optional]<br><br>A comma-separated list of relative working directories, to determine the audit targets locations.</p> |
| --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. |
| --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> |
| --fixable-only | <p>[Optional]<br><br>Set to true if you wish to display issues that have a fix version only.</p> |
| --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> |
Expand Down
Loading