From 22fd7065a205b7e1b6f24f249b50774da8678b2e Mon Sep 17 00:00:00 2001
From: benja-M-1 <212269+benja-M-1@users.noreply.github.com>
Date: Tue, 31 Mar 2026 14:36:12 +0000
Subject: [PATCH] [BOT] Update docs for v1.20.4 release
---
docs/docker_scout_compare.yaml | 1 +
docs/scout_compare.md | 52 +++++++++++++++++-----------------
2 files changed, 27 insertions(+), 26 deletions(-)
diff --git a/docs/docker_scout_compare.yaml b/docs/docker_scout_compare.yaml
index dfcb4ccc..c9205a92 100644
--- a/docs/docker_scout_compare.yaml
+++ b/docs/docker_scout_compare.yaml
@@ -69,6 +69,7 @@ options:
Output format of the generated vulnerability report:
- text: default output, plain text with or without colors depending on the terminal
- markdown: Markdown output
+ - json: JSON output
deprecated: false
hidden: false
experimental: false
diff --git a/docs/scout_compare.md b/docs/scout_compare.md
index 0461896b..ca585350 100644
--- a/docs/scout_compare.md
+++ b/docs/scout_compare.md
@@ -9,32 +9,32 @@ Compare two images and display differences (experimental)
### Options
-| Name | Type | Default | Description |
-|:----------------------|:--------------|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `-x`, `--exit-on` | `stringSlice` | | Comma separated list of conditions to fail the action step if worse or changed, options are: vulnerability, policy, package |
-| `--format` | `string` | `text` | Output format of the generated vulnerability report:
- text: default output, plain text with or without colors depending on the terminal
- markdown: Markdown output
|
-| `--hide-policies` | | | Hide policy status from the output |
-| `--ignore-base` | | | Filter out CVEs introduced from base image |
-| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope |
-| `--ignore-unchanged` | | | Filter out unchanged packages |
-| `--multi-stage` | | | Show packages from multi-stage Docker builds |
-| `--only-fixed` | | | Filter to fixable CVEs |
-| `--only-package-type` | `stringSlice` | | Comma separated list of package types (like apk, deb, rpm, npm, pypi, golang, etc) |
-| `--only-policy` | `stringSlice` | | Comma separated list of policies to evaluate |
-| `--only-severity` | `stringSlice` | | Comma separated list of severities (critical, high, medium, low, unspecified) to filter CVEs by |
-| `--only-stage` | `stringSlice` | | Comma separated list of multi-stage Docker build stage names |
-| `--only-unfixed` | | | Filter to unfixed CVEs |
-| `--only-vex-affected` | | | Filter CVEs by VEX statements with status not affected |
-| `--org` | `string` | | Namespace of the Docker organization |
-| `-o`, `--output` | `string` | | Write the report to a file |
-| `--platform` | `string` | | Platform of image to analyze |
-| `--ref` | `string` | | Reference to use if the provided tarball contains multiple references.
Can only be used with archive |
-| `--to` | `string` | | Image, directory, or archive to compare to |
-| `--to-env` | `string` | | Name of environment to compare to |
-| `--to-latest` | | | Latest image processed to compare to |
-| `--to-ref` | `string` | | Reference to use if the provided tarball contains multiple references.
Can only be used with archive. |
-| `--vex-author` | `stringSlice` | `[<.*@docker.com>]` | List of VEX statement authors to accept |
-| `--vex-location` | `stringSlice` | | File location of directory or file containing VEX statements |
+| Name | Type | Default | Description |
+|:----------------------|:--------------|:--------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `-x`, `--exit-on` | `stringSlice` | | Comma separated list of conditions to fail the action step if worse or changed, options are: vulnerability, policy, package |
+| `--format` | `string` | `text` | Output format of the generated vulnerability report:
- text: default output, plain text with or without colors depending on the terminal
- markdown: Markdown output
- json: JSON output
|
+| `--hide-policies` | | | Hide policy status from the output |
+| `--ignore-base` | | | Filter out CVEs introduced from base image |
+| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope |
+| `--ignore-unchanged` | | | Filter out unchanged packages |
+| `--multi-stage` | | | Show packages from multi-stage Docker builds |
+| `--only-fixed` | | | Filter to fixable CVEs |
+| `--only-package-type` | `stringSlice` | | Comma separated list of package types (like apk, deb, rpm, npm, pypi, golang, etc) |
+| `--only-policy` | `stringSlice` | | Comma separated list of policies to evaluate |
+| `--only-severity` | `stringSlice` | | Comma separated list of severities (critical, high, medium, low, unspecified) to filter CVEs by |
+| `--only-stage` | `stringSlice` | | Comma separated list of multi-stage Docker build stage names |
+| `--only-unfixed` | | | Filter to unfixed CVEs |
+| `--only-vex-affected` | | | Filter CVEs by VEX statements with status not affected |
+| `--org` | `string` | | Namespace of the Docker organization |
+| `-o`, `--output` | `string` | | Write the report to a file |
+| `--platform` | `string` | | Platform of image to analyze |
+| `--ref` | `string` | | Reference to use if the provided tarball contains multiple references.
Can only be used with archive |
+| `--to` | `string` | | Image, directory, or archive to compare to |
+| `--to-env` | `string` | | Name of environment to compare to |
+| `--to-latest` | | | Latest image processed to compare to |
+| `--to-ref` | `string` | | Reference to use if the provided tarball contains multiple references.
Can only be used with archive. |
+| `--vex-author` | `stringSlice` | `[<.*@docker.com>]` | List of VEX statement authors to accept |
+| `--vex-location` | `stringSlice` | | File location of directory or file containing VEX statements |