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.

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

feat!: emit defaults to CycloneDX1.6 #1333

Merged
merged 4 commits into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@ All notable changes to this project will be documented in this file.
<!-- unreleased changes go here -->

* BREAKING Changes
* Option `specVersion` defaults to `"1.6"`, was `"1.4"` ([#1329] via [#1333])
* Emit `.metadata.tools` as components ([#1330] via [#1331])
This affects only CycloneDX spec-version 1.5 and later.
* Build
* Use _TypeScript_ `v5.7.3` now, was `v5.6.3` (via [#1351])

[#1329]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/issues/1329
[#1330]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/issues/1330
[#1331]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1331
[#1333]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1333
[#1351]: https://github.com/CycloneDX/cyclonedx-webpack-plugin/pull/1351

## 3.17.0 - 2025-01-10
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ new CycloneDxWebpackPlugin(options?: object)

| Name | Type | Default | Description |
|:-----|:----:|:-------:|:------------|
| **`specVersion`** | `{string}`<br/> one of: `"1.2"`, `"1.3"`, `"1.4"`, `"1.5"`, `"1.6"` | `"1.4"` | Which version of [CycloneDX-spec] to use.<br/> Supported values depend on the installed dependency [CycloneDX-javascript-library]. |
| **`specVersion`** | `{string}`<br/> one of: `"1.2"`, `"1.3"`, `"1.4"`, `"1.5"`, `"1.6"` | `"1.6"` | Which version of [CycloneDX-spec] to use.<br/> Supported values depend on the installed dependency [CycloneDX-javascript-library]. |
| **`reproducibleResults`** | `{boolean}` | `false` | Whether to go the extra mile and make the output reproducible.<br/> Reproducibility might result in loss of time- and random-based-values. |
| **`validateResults`** | `{boolean}` | `true` | Whether to validate the BOM result.<br/> Validation is skipped, if requirements not met. Requires [transitive optional dependencies](https://github.com/CycloneDX/cyclonedx-javascript-library#optional-dependencies). |
| **`outputLocation`** | `{string}` | `"./cyclonedx"` | Path to write the output to. The path is relative to _webpack_'s overall output path. |
Expand Down
2 changes: 1 addition & 1 deletion src/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ export class CycloneDxWebpackPlugin {
collectEvidence: boolean

constructor ({
specVersion = CDX.Spec.Version.v1dot4,
specVersion = CDX.Spec.Version.v1dot6,
reproducibleResults = false,
validateResults = true,
outputLocation = './cyclonedx',
Expand Down
Loading
Loading