Skip to content

Commit 7da3739

Browse files
committed
switch recommended cdx format to 1.5
Signed-off-by: Brian DeHamer <[email protected]>
1 parent fd7783d commit 7da3739

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

accepted/0000-sbom-command.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Supported command options:
3737

3838
If the user runs the `sbom` command without first installing the dependencies for the project (i.e. there is no _node_modules_ folder present) an error will be displayed. An SBOM can be generated solely based on the contents of the _package-lock.json_ but requires the user to explicitly specify the `--package-lock-only` flag.
3939

40-
Initially, we'll support the most widely used versions of the SPDX and CycloneDX specifications (likely v2.3 for SPDX and v1.4 for CycloneDX). Best effort will be made to support new versions as they gain adoption across the ecosystem.
40+
Initially, we'll support the most widely used versions of the SPDX and CycloneDX specifications (likely v2.3 for SPDX and v1.5 for CycloneDX). Best effort will be made to support new versions as they gain adoption across the ecosystem.
4141

4242

4343
## Rationale and Alternatives
@@ -97,7 +97,7 @@ Both of the SBOM formats present a flat list of dependencies (CycloneDX groups t
9797
}
9898
```
9999

100-
The <code>[properties](https://cyclonedx.org/docs/1.4/json/#components_items_properties)</code> collection also provides for a standard property under the [npm taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/npm.md) for annotating development dependencies. For any package which was determined to be a development dependency of the root project, we would add the following to the <code>properties</code> collection:
100+
The <code>[properties](https://cyclonedx.org/docs/1.5/json/#components_items_properties)</code> collection also provides for a standard property under the [npm taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/npm.md) for annotating development dependencies. For any package which was determined to be a development dependency of the root project, we would add the following to the <code>properties</code> collection:
101101

102102
```json
103103
{
@@ -108,7 +108,7 @@ The <code>[properties](https://cyclonedx.org/docs/1.4/json/#components_items_pro
108108

109109
Similarly, there are named properties defined for identifying things like "bundled", "private", and "extraneous" dependencies. Dependencies will be annotated with this properties as appropriate.
110110

111-
The CycloneDX specification also provides [fields](https://cyclonedx.org/docs/1.4/json/#components) for capturing other package metadata like author, license, website, etc. Not all packages provide this information, but these fields will be populated when the information is available.
111+
The CycloneDX specification also provides [fields](https://cyclonedx.org/docs/1.5/json/#components) for capturing other package metadata like author, license, website, etc. Not all packages provide this information, but these fields will be populated when the information is available.
112112

113113
For generating the CycloneDX SBOM, we could utilize the <code>[@cyclonedx/cyclonedx-library](https://www.npmjs.com/package/@cyclonedx/cyclonedx-library)</code> (2.9MB unpacked) package which provides data models and serializers for generating valid CycloneDX documents. This library has direct dependencies on <code>[spdx-expression-parse](https://www.npmjs.com/package/spdx-expression-parse)</code> (which is already included as part of the npm CLI) and <code>[packageurl-js](https://www.npmjs.com/package/packageurl-js)</code> (39kB unpacked).
114114

@@ -213,9 +213,9 @@ The proposed CycloneDX SBOM generated for the project above would look like the
213213

214214
```json
215215
{
216-
"$schema": "https://cyclonedx.org/schema/bom-1.4.schema.json",
216+
"$schema": "https://cyclonedx.org/schema/bom-1.5.schema.json",
217217
"bomFormat": "CycloneDX",
218-
"specVersion": "1.4",
218+
"specVersion": "1.5",
219219
"serialNumber": "urn:uuid:f2fa9eae-72f1-430c-a9b3-986ffe05bc6e",
220220
"version": 1,
221221
"metadata": {

0 commit comments

Comments
 (0)