Skip to content

[BOT] Update docs for v1.25.0 release #240

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.

Sign up for GitHub

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

Open
docker-scout-ci wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[BOT] Update docs for v1.25.0 release #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions docs/docker_scout_compare.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,7 @@ options:
- option: ignore-suppressed
value_type: bool
default_value: "false"
description: |
Filter CVEs found in Scout exceptions based on the specified exception scope
description: Filter out CVEs suppressed by a Scout exception
deprecated: false
hidden: false
experimental: false
Expand Down
3 changes: 1 addition & 2 deletions docs/docker_scout_cves.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,7 @@ options:
- option: ignore-suppressed
value_type: bool
default_value: "false"
description: |
Filter CVEs found in Scout exceptions based on the specified exception scope
description: Filter out CVEs suppressed by a Scout exception
deprecated: false
hidden: false
experimental: false
Expand Down
3 changes: 1 addition & 2 deletions docs/docker_scout_quickview.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ options:
- option: ignore-suppressed
value_type: bool
default_value: "false"
description: |
Filter CVEs found in Scout exceptions based on the specified exception scope
description: Filter out CVEs suppressed by a Scout exception
deprecated: false
hidden: false
experimental: false
Expand Down
1 change: 0 additions & 1 deletion docs/docker_scout_vex.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
command: docker scout vex
aliases: docker scout vex, docker scout vex
short: Manage VEX attestations on images
long: Manage VEX attestations on images
pname: docker scout
Expand Down
2 changes: 1 addition & 1 deletion docs/scout_compare.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Compare two images and display differences (experimental)
| `--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> |
| `--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-suppressed` | | | Filter out CVEs suppressed by a Scout exception |
| `--ignore-unchanged` | | | Filter out unchanged packages |
| `--multi-stage` | | | Show packages from multi-stage Docker builds |
| `--only-fixed` | | | Filter to fixable CVEs |
Expand Down
2 changes: 1 addition & 1 deletion docs/scout_cves.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Display CVEs identified in a software artifact
| `-e`, `--exit-code` | | | Return exit code '2' if vulnerabilities are detected |
| `--format` | `string` | `packages` | Output format of the generated vulnerability report:<br>- packages: default output, plain text with vulnerabilities grouped by packages<br>- sarif: json Sarif output<br>- spdx: json SPDX output<br>- gitlab: json GitLab output<br>- markdown: markdown output (including some html tags like collapsible sections)<br>- sbom: json SBOM output<br> |
| `--ignore-base` | | | Filter out CVEs introduced from base image |
| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope |
| `--ignore-suppressed` | | | Filter out CVEs suppressed by a Scout exception |
| `--locations` | | | Print package locations including file paths and layer diff_id |
| `--multi-stage` | | | Show packages from multi-stage Docker builds |
| `--only-base` | | | Only show CVEs introduced by the base image |
Expand Down
2 changes: 1 addition & 1 deletion docs/scout_quickview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Quick overview of an image
| Name | Type | Default | Description |
|:----------------------|:--------------|:--------------------|:--------------------------------------------------------------------------------------------------------|
| `--env` | `string` | | Name of the environment |
| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope |
| `--ignore-suppressed` | | | Filter out CVEs suppressed by a Scout exception |
| `--latest` | | | Latest indexed image |
| `--only-policy` | `stringSlice` | | Comma separated list of policies to evaluate |
| `--only-vex-affected` | | | Filter CVEs by VEX statements with status not affected |
Expand Down
4 changes: 0 additions & 4 deletions docs/scout_vex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
<!---MARKER_GEN_START-->
Manage VEX attestations on images

### Aliases

`docker scout vex`, `docker scout vex`

### Subcommands

| Name | Description |
Expand Down
Loading