Skip to content

Commit

Permalink
Improve command descriptions, add usage and examples (#112)
Browse files Browse the repository at this point in the history
  • Loading branch information
sverdlov93 authored Apr 18, 2024
1 parent 08f7c61 commit dfd731e
Show file tree
Hide file tree
Showing 17 changed files with 317 additions and 93 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@ jobs:
- uses: actions/checkout@v4

- name: Install Go
uses: actions/setup-go@v3
uses: actions/setup-go@v5
with:
go-version: 1.21.x
cache: 'false'

- name: Go Cache
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/go/pkg/mod
key: ubuntu-go-${{ hashFiles('**/go.sum') }}
Expand Down
3 changes: 2 additions & 1 deletion jfrog-applications/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@
* [CLI for JFrog Security](jfrog-cli/cli-for-jfrog-security/README.md)
* [Authentication](jfrog-cli/cli-for-jfrog-security/authentication.md)
* [Scan your Source Code](jfrog-cli/cli-for-jfrog-security/scan-your-source-code.md)
* [Scan your Binaries](jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md)
* [cUrl Integration](jfrog-cli/cli-for-jfrog-security/curl-integration.md)
* [Scan Published Builds](jfrog-cli/cli-for-jfrog-security/scan-published-builds.md)
* [Scan your Binaries](jfrog-cli/cli-for-jfrog-security/scan-your-binaries.md)
* [Download Updates for Xray's Database](jfrog-cli/cli-for-jfrog-security/download-updates-for-xrays-database.md)
* [CLI for JFrog Curation](jfrog-cli/cli-for-jfrog-curation.md)
* [CLI for JFrog Distribution](jfrog-cli/cli-for-jfrog-distribution.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ If new vulnerabilities are found, Frogbot adds them as a comment on the pull req

**VULNERABLE DEPENDENCIES**

| SEVERITY | CONTEXTUAL ANALYSIS | DIRECT DEPENDENCIES | IMPACTED DEPENDENCY | FIXED VERSIONS |
| :---------------------------------------------------------------------------------------------------------------------------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------------: |
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/notApplicableCritical.png" alt=""><br>Critical</p> | Not Applicable | minimist:1.2.5 | minimist:1.2.5 | <p>[0.2.4]<br>[1.2.6]</p> |
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/applicableHighSeverity.png" alt=""><br>High</p> | Applicable | protobufjs:6.11.2 | protobufjs:6.11.2 | \[6.11.3] |
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/notApplicableHigh.png" alt=""><br>High</p> | Not Applicable | lodash:4.17.19 | lodash:4.17.19 | \[4.17.21] |
| SEVERITY | CONTEXTUAL ANALYSIS | DIRECT DEPENDENCIES | IMPACTED DEPENDENCY | FIXED VERSIONS |
|:-----------------------------------------------------------------------------------------------------------------------------------:|:-------------------:|:-------------------:|:-------------------:|:-------------------------:|
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/notApplicableCritical.png" alt=""><br>Critical</p> | Not Applicable | minimist:1.2.5 | minimist:1.2.5 | <p>[0.2.4]<br>[1.2.6]</p> |
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/applicableHighSeverity.png" alt=""><br>High</p> | Applicable | protobufjs:6.11.2 | protobufjs:6.11.2 | \[6.11.3] |
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/notApplicableHigh.png" alt=""><br>High</p> | Not Applicable | lodash:4.17.19 | lodash:4.17.19 | \[4.17.21] |

**Vulnerability Contextual Analysis**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

After you create a new pull request, Frogbot will automatically scan it.

_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all of the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file.
_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file.

The Frogbot scan on Bitbucket Server workflow:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Scan Github Pull Request
# Scan GitHub Pull Request

After you create a new pull request, the maintainer of the Git repository can trigger Frogbot to scan the pull request from the pull request UI.

_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all of the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file.
_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file.

The Frogbot GitHub scan workflow is:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

After you create a new merge request, the maintainer of the Git repository can trigger Frogbot to scan the merge request from the merge request UI.

_**NOTE:**_ The scan output will include only new vulnerabilities added by the merge request. Vulnerabilities that aren't new, and existed in the code before the merge request was created, will not be included in the report. In order to include all of the vulnerabilities in the report, including older ones that weren't added by this merge request, use the includeAllVulnerabilities parameter in the frogbot-config.yml file.
_**NOTE:**_ The scan output will include only new vulnerabilities added by the merge request. Vulnerabilities that aren't new, and existed in the code before the merge request was created, will not be included in the report. In order to include all the vulnerabilities in the report, including older ones that weren't added by this merge request, use the includeAllVulnerabilities parameter in the frogbot-config.yml file.

The Frogbot GitLab flow is as follows:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# View Security Alerts on Github
# View Security Alerts on GitHub

For GitHub repositories, issues that are found during Frogbot's periodic scans are also added to the [Security Alerts](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository) view in the UI.

Expand Down
Loading

0 comments on commit dfd731e

Please sign in to comment.