Skip to content

Commit 0390daf

Browse files
benja-M-1benja-M-1
authored
Merge pull request #224 from docker/release/v1.20.4
2 parents 48f3372 + 22fd706 commit 0390daf

File tree

2 files changed

+27
-26
lines changed

2 files changed

+27
-26
lines changed

‎docs/docker_scout_compare.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ options:
6969
Output format of the generated vulnerability report:
7070
- text: default output, plain text with or without colors depending on the terminal
7171
- markdown: Markdown output
72+
- json: JSON output
7273
deprecated: false
7374
hidden: false
7475
experimental: false

‎docs/scout_compare.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,32 @@ Compare two images and display differences (experimental)
99

1010
### Options
1111

12-
| Name | Type | Default | Description |
13-
|:----------------------|:--------------|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14-
| `-x`, `--exit-on` | `stringSlice` | | Comma separated list of conditions to fail the action step if worse or changed, options are: vulnerability, policy, package |
15-
| `--format` | `string` | `text` | Output format of the generated vulnerability report:<br>- text: default output, plain text with or without colors depending on the terminal<br>- markdown: Markdown output<br> |
16-
| `--hide-policies` | | | Hide policy status from the output |
17-
| `--ignore-base` | | | Filter out CVEs introduced from base image |
18-
| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope |
19-
| `--ignore-unchanged` | | | Filter out unchanged packages |
20-
| `--multi-stage` | | | Show packages from multi-stage Docker builds |
21-
| `--only-fixed` | | | Filter to fixable CVEs |
22-
| `--only-package-type` | `stringSlice` | | Comma separated list of package types (like apk, deb, rpm, npm, pypi, golang, etc) |
23-
| `--only-policy` | `stringSlice` | | Comma separated list of policies to evaluate |
24-
| `--only-severity` | `stringSlice` | | Comma separated list of severities (critical, high, medium, low, unspecified) to filter CVEs by |
25-
| `--only-stage` | `stringSlice` | | Comma separated list of multi-stage Docker build stage names |
26-
| `--only-unfixed` | | | Filter to unfixed CVEs |
27-
| `--only-vex-affected` | | | Filter CVEs by VEX statements with status not affected |
28-
| `--org` | `string` | | Namespace of the Docker organization |
29-
| `-o`, `--output` | `string` | | Write the report to a file |
30-
| `--platform` | `string` | | Platform of image to analyze |
31-
| `--ref` | `string` | | Reference to use if the provided tarball contains multiple references.<br>Can only be used with archive |
32-
| `--to` | `string` | | Image, directory, or archive to compare to |
33-
| `--to-env` | `string` | | Name of environment to compare to |
34-
| `--to-latest` | | | Latest image processed to compare to |
35-
| `--to-ref` | `string` | | Reference to use if the provided tarball contains multiple references.<br>Can only be used with archive. |
36-
| `--vex-author` | `stringSlice` | `[<.*@docker.com>]` | List of VEX statement authors to accept |
37-
| `--vex-location` | `stringSlice` | | File location of directory or file containing VEX statements |
12+
| Name | Type | Default | Description |
13+
|:----------------------|:--------------|:--------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14+
| `-x`, `--exit-on` | `stringSlice` | | Comma separated list of conditions to fail the action step if worse or changed, options are: vulnerability, policy, package |
15+
| `--format` | `string` | `text` | Output format of the generated vulnerability report:<br>- text: default output, plain text with or without colors depending on the terminal<br>- markdown: Markdown output<br>- json: JSON output<br> |
16+
| `--hide-policies` | | | Hide policy status from the output |
17+
| `--ignore-base` | | | Filter out CVEs introduced from base image |
18+
| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope |
19+
| `--ignore-unchanged` | | | Filter out unchanged packages |
20+
| `--multi-stage` | | | Show packages from multi-stage Docker builds |
21+
| `--only-fixed` | | | Filter to fixable CVEs |
22+
| `--only-package-type` | `stringSlice` | | Comma separated list of package types (like apk, deb, rpm, npm, pypi, golang, etc) |
23+
| `--only-policy` | `stringSlice` | | Comma separated list of policies to evaluate |
24+
| `--only-severity` | `stringSlice` | | Comma separated list of severities (critical, high, medium, low, unspecified) to filter CVEs by |
25+
| `--only-stage` | `stringSlice` | | Comma separated list of multi-stage Docker build stage names |
26+
| `--only-unfixed` | | | Filter to unfixed CVEs |
27+
| `--only-vex-affected` | | | Filter CVEs by VEX statements with status not affected |
28+
| `--org` | `string` | | Namespace of the Docker organization |
29+
| `-o`, `--output` | `string` | | Write the report to a file |
30+
| `--platform` | `string` | | Platform of image to analyze |
31+
| `--ref` | `string` | | Reference to use if the provided tarball contains multiple references.<br>Can only be used with archive |
32+
| `--to` | `string` | | Image, directory, or archive to compare to |
33+
| `--to-env` | `string` | | Name of environment to compare to |
34+
| `--to-latest` | | | Latest image processed to compare to |
35+
| `--to-ref` | `string` | | Reference to use if the provided tarball contains multiple references.<br>Can only be used with archive. |
36+
| `--vex-author` | `stringSlice` | `[<.*@docker.com>]` | List of VEX statement authors to accept |
37+
| `--vex-location` | `stringSlice` | | File location of directory or file containing VEX statements |
3838

3939

4040
<!---MARKER_GEN_END-->

0 commit comments

Comments
 (0)