Skip to content

Commit

Permalink
improve multi-value and boolean descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
hboutemy committed Aug 2, 2023
1 parent a6582f5 commit 02e3cdb
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions cdx/maven.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
| --------- | ----------- |
| `cdx:maven:package` | Namespace for package specific properties. |

_Boolean value_ are `true` or `false`. Case insensitive.

## `cdx:maven:package` Namespace Taxonomy

| Property | Description |
| -------- | ----------- |
| `cdx:maven:package:goal` | The goal used to generate the SBOM: `makeBom`, `makeAggregateBom` or `makePackageBom`. |
| `cdx:maven:package:scopes` | The activated Maven dependency scopes: `compile`, `provided`, `runtime`, `system` or `test`, comma-separated if many. |
| `cdx:maven:package:reproducible` | Whether the SBOM has been generated in Reproducible Builds mode: in this mode, metadata timestamp and BOM serial number are dropped. _Boolean value_. If the property is missing, then assume the value to be `false`. |
| `cdx:maven:package:goal` | The goal used to generate the SBOM: `makeBom`, `makeAggregateBom` or `makePackageBom`. May appear once. |
| `cdx:maven:package:scope` | An activated Maven dependency scope: `compile`, `provided`, `runtime`, `system` or `test`. |
| `cdx:maven:package:reproducible` | Whether the SBOM has been generated in Reproducible Builds mode: in this mode, metadata timestamp and BOM serial number are dropped. _Boolean value_. If the property is missing, then assume the value to be `false`. May appear once. |
| `cdx:maven:package:optional-unused` | Use bytecode analysis instead of Maven dependency declaration of optional to define SBOM OPTIONAL or REQUIRED scope. _Boolean value_. If the property is missing, then assume the value to be `false`. May appear once. |

0 comments on commit 02e3cdb

Please sign in to comment.