Skip to content

Commit 28b4b4f

Browse files
committed
chore: prep v2.0.0
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 06b3acf commit 28b4b4f

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

HISTORY.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,32 @@ All notable changes to this project will be documented in this file.
44

55
## unreleased
66

7-
* Breaking Changes:
7+
## 2.0.0 -- 2023-05-17
8+
9+
Improved license detection.
10+
Finalized `Vulnerability` capabilities.
11+
Added `ComponentEvidence` capabilities.
12+
13+
* BREAKING
14+
* Function `Factories.LicenseFactory.makeFromString()` was changed in its behavior ([#271], [#530] via [#547])
15+
It will try to create `Models.SpdxLicense` if value is eligible,
16+
else try to create `Models.LicenseExpression` if value is eligible,
17+
else fall back to `Models.NamedLicense`.
18+
* Removed deprecated symbols ([#747] via [#752])
19+
* Changed
20+
* Removed _beta_ state from symbols `{Enums,Models}.Vulnerability.*` ([#164] via [#722])
21+
The structures are defined as stable now.
22+
* Added
23+
* New data models and serialization/normalization for `Models.ComponentEvidence` ([#516] via [#753])
24+
* Serializers and `Component`-Normalizers will take `Models.Component.evidence` into account ([#516] via [#753])
25+
* Serializers and `Bom`-Normalizers will take `Models.Bom.vulnerabilities` into account ([#164] via [#722])
26+
* Misc
27+
Internal rework, modernization, refactoring.
28+
29+
### API changes v2 - the details
30+
31+
* BREAKING
832
* Class `Factories.LicenseFactory` was modified
9-
* Function `makeFromString()` was changed in its behavior ([#271], [#530] via [#547])
10-
Will try to create `Models.SpdxLicense` if value is eligible,
11-
else try to create `Models.LicenseExpression` if value is eligible,
12-
else fall back to `Models.NamedLicense`.
1333
* Renamed function `makeDisjunctiveWithId()` -> `makeSpdxLicense()` ([#530] via [#547])
1434
* Renamed function `makeDisjunctiveWithName()` -> `makeNamedLicense()` ([#530] via [#547])
1535
* Class `Models.LicenseExpression` was modified
@@ -39,8 +59,6 @@ All notable changes to this project will be documented in this file.
3959
* Functions `Models.*.compare()` may return different numbers than before.
4060
* Functions `Models.*.sorted()` may return different orders than before.
4161
* Changed
42-
* Removed _beta_ state from symbols `{Enums,Models}.Vulnerability.*` ([#164] via [#722])
43-
The structures are defined as stable now.
4462
* Class `Models.Attachment` was modified
4563
* Property `content` was widened to be any stringable, was `string` ([#516] via [#753])
4664
This enables the use of `Buffer` and other data-saving mechanisms.
@@ -55,8 +73,6 @@ All notable changes to this project will be documented in this file.
5573
This collection(`Set`) will always exist, but might be empty.
5674
This is considered a non-breaking change, as the class was in _beta_ state.
5775
* Added
58-
* Serializers and `Bom`-Normalizers will take `Models.Bom.vulnerabilities` into account ([#164] via [#722])
59-
* Serializers and `Component`-Normalizers will take `Models.Component.evidence` into account ([#516] via [#753])
6076
* Namespace `Models` was enhanced
6177
* Class `Component` was enhanced
6278
* New optional property `evidence` of type `Models.ComponentEvidence` ([#516] via [#753])
@@ -127,7 +143,7 @@ All notable changes to this project will be documented in this file.
127143
* Namespace `Spdx` was enhanced
128144
* New function `isValidSpdxLicenseExpression()` ([#271] via [#547])
129145
* Misc
130-
* New dependency `spdx-expression-parse` (via [#547])
146+
* Added dependency `spdx-expression-parse@^3.0.1` (via [#547])
131147

132148
[#164]: https://github.com/CycloneDX/cyclonedx-javascript-library/issues/164
133149
[#271]: https://github.com/CycloneDX/cyclonedx-javascript-library/issues/271

0 commit comments

Comments
 (0)