Skip to content

Commit

Permalink
init maven taxonomy with existing properties
Browse files Browse the repository at this point in the history
fixes CycloneDX#68

Signed-off-by: Hervé Boutemy <hboutemy@apache.org>
  • Loading branch information
hboutemy committed Aug 22, 2023
1 parent f54283a commit 7b80e70
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions cdx.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ _Boolean value_ are `true` or `false`. Case sensitive.
| `cdx:composer` | Namespace for properties specific to the PHP Composer ecosystem. | CycloneDX PHP Maintainers | [cdx:composer taxonomy](cdx/composer.md) |
| `cdx:device` | Namespace for properties specific to hardware devices. | CycloneDX Core Working Group | [cdx:device taxonomy](cdx/device.md) |
| `cdx:gomod` | Namespace for properties specific to the Go Module ecosystem. | CycloneDX Go Maintainers | [cdx:gomod taxonomy](cdx/gomod.md) |
| `cdx:maven` | Namespace for properties specific to the Maven plugin. | CycloneDX Maven Plugin Maintainers | [cdx:maven taxonomy](cdx/maven.md) |
| `cdx:npm` | Namespace for properties specific to the Node NPM ecosystem. | CycloneDX JavaScript Maintainers | [cdx:npm taxonomy](cdx/npm.md) |
| `cdx:pipenv` | Namespace for properties specific to the Python Pipenv ecosystem. | CycloneDX Python Maintainers | [cdx:pipenv taxonomy](cdx/pipenv.md) |
| `cdx:poetry` | Namespace for properties specific to the Python Poetry ecosystem. | CycloneDX Python Maintainers | [cdx:poetry taxonomy](cdx/poetry.md) |
Expand Down
14 changes: 14 additions & 0 deletions cdx/maven.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# `cdx:maven` Namespace Taxonomy

| Namespace | Description |
| --------- | ----------- |
| `cdx:maven:package` | Namespace for package specific properties. |

## `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: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 7b80e70

Please sign in to comment.