Skip to content

Commit

Permalink
docs: synchronizing help from snyk/user-docs (#5063)
Browse files Browse the repository at this point in the history
Co-authored-by: Avishagp <noreply@snyk.io>
  • Loading branch information
github-actions[bot] and Avishagp committed Mar 13, 2024
1 parent bd6351a commit ade5860
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion help/cli-commands/container-sbom.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Required. The image for which you will generate an SBOM document.

### Create a SPDX JSON document for an image while excluding application dependencies

`$ snyk container sbom --format=spdx2.3+json redis:latest ----exclude-app-vulns`
`$ snyk container sbom --format=spdx2.3+json redis:latest --exclude-app-vulns`

### Refer to a container image by its digest

Expand Down
8 changes: 4 additions & 4 deletions help/cli-commands/monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,13 +221,13 @@ This is an alias for `--project-tags`

### `--maven-aggregate-project`

Use `--maven-aggregate-project` instead of `--all-projects` when scanning Maven aggregate projects, that is, ones that use modules and inheritance.
Use `--maven-aggregate-project` instead of `--all-projects` when scanning Maven aggregate projects, that is, projects that use modules and inheritance.

When scanning these types of projects, Snyk performs a compile to ensure all modules are resolvable by the Maven reactor.
Using `--maven-aggregate-project` instructs Snyk to perform a compilation step to ensure all modules within the project are resolvable by the Maven reactor. This ensures a comprehensive scan that includes dependencies of all sub-modules.

Be sure to run the scan in the same directory as the root pom.xml file.
Be sure to run the scan in the same directory as the root `pom.xml` file.

Snyk reports test results per pom.xml file.
Snyk reports the test results per individual `pom.xml` file within the aggregate project.

### `--scan-unmanaged`

Expand Down
8 changes: 4 additions & 4 deletions help/cli-commands/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,13 +224,13 @@ To fail on any Snyk-discoverable vulnerability (the default behavior), do not us

### `--maven-aggregate-project`

Use `--maven-aggregate-project` instead of `--all-projects` when scanning Maven aggregate projects, that is, ones that use modules and inheritance.
Use `--maven-aggregate-project` instead of `--all-projects` when scanning Maven aggregate projects, that is, projects that use modules and inheritance.

When scanning these types of projects, Snyk performs a compile to ensure all modules are resolvable by the Maven reactor.
Using `--maven-aggregate-project` instructs Snyk to perform a compilation step to ensure all modules within the project are resolvable by the Maven reactor. This ensures a comprehensive scan that includes dependencies of all sub-modules.

Be sure to run the scan in the same directory as the root pom.xml file.
Be sure to run the scan in the same directory as the root `pom.xml` file.

Snyk reports test results per pom.xml file.
Snyk reports the test results per individual `pom.xml` file within the aggregate project.

### `--scan-unmanaged`

Expand Down

0 comments on commit ade5860

Please sign in to comment.