Skip to content
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

Jump to bottom

init cdx:maven taxonomy with existing properties #69

Closed
wants to merge 4 commits into from
Closed

init cdx:maven taxonomy with existing properties #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b80e70
init maven taxonomy with existing properties
hboutemy Jul 31, 2023
8ac1c45
improve multi-value and boolean descriptions
hboutemy Aug 2, 2023
689638e
drop Maven-specific reproducible, use #70
hboutemy Aug 13, 2023
4735465
add links to reference documentation
hboutemy Aug 21, 2023
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
1 change: 1 addition & 0 deletions cdx.md
View file
Open in desktop
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
18 changes: 18 additions & 0 deletions cdx/maven.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# `cdx:maven` Namespace Taxonomy

| Namespace | Description |
| --------- | ----------- |
| `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`. May appear once. |
| `cdx:maven:package:scope` | An activated Maven [dependency scope]: `compile`, `provided`, `runtime`, `system` or `test`. |
| `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. |

[goal]: https://github.com/CycloneDX/cyclonedx-maven-plugin#goals
[dependency scope]: https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Dependency_Scope