1
1
# CHANGELOG
2
2
3
3
4
- ## Unreleased
5
4
6
- ### Documentation
7
-
8
- * docs(chaneglog): omit chore/ci/refactor/style/test/build (#703 )
9
-
10
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` a210809 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/a210809efb34c2dc895fc0c6d96a3412a9097625 ) )
11
-
12
- * docs: rephrase migration paths
5
+ ## v8.0.0 (2024-10-14)
13
6
14
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` b0260a7 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/b0260a7d45bc3e099b979001049a8c5a67b97634 ) )
15
-
16
- ### Unknown
7
+ ### Breaking
17
8
18
- * Merge remote-tracking branch &# 39 ; origin/main &# 39 ; into 8 .0.0-dev ( [ ` b9a33e6 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/b9a33e614a84ba4a6546a1907b70a0cbfee8cd6f ) )
9
+ * feat!: v8 .0.0 ( # 665 )
19
10
20
- * rework tools xml deserializer (#700 )
11
+ ### BREAKING Changes
12
+
13
+ * Removed ` cyclonedx.mode.ThisTool ` , utilize ` cyclonedx.builder.this.this_tool() ` instead.
14
+ * Moved ` cyclonedx.model.Tool ` to ` cyclonedx.model.tool.Tool ` .
15
+ * Property ` cyclonedx.mode.bom.BomMetaData.tools ` is of type ` cyclonedx.model.tool.ToolRepository ` now, was ` SortedSet[cyclonedx.model.Tool] ` .
16
+ The getter will act accordingly; the setter might act in a backwards-compatible way.
17
+ * Property ` cyclonedx.mode.vulnerability.Vulnerability.tools ` is of type ` cyclonedx.model.tool.ToolRepository ` now, was ` SortedSet[cyclonedx.model.Tool] ` .
18
+ The getter will act accordingly; the setter might act in a backwards-compatible way.
19
+ * Constructor ` cyclonedx.model.license.LicenseExpression() ` accepts optional argument ` acknowledgement ` only as key-word argument, no longer as positional argument.
20
+
21
+
22
+ ### Changes
23
+
24
+ * Constructor of ` cyclonedx.model.bom.BomMetaData ` also accepts an instance of ` cyclonedx.model.tool.ToolRepository ` for argument ` tools ` .
25
+ * Constructor of ` cyclonedx.model.bom.BomMetaData ` no longer adds this very library as a tool.
26
+ Downstream users SHOULD add it manually, like ` my-bom.metadata.tools.components.add(cyclonedx.builder.this.this_component()) ` .
27
+
28
+ ### Fixes
29
+
30
+ * Deserialization of CycloneDX that do not include tools in the metadata are no longer unexpectedly modified/altered.
31
+
32
+ ### Added
33
+
34
+ Enabled Metadata Tools representation and serialization in accordance with CycloneDX 1.5
35
+
36
+ * New class ` cyclonedx.model.tool.ToolRepository ` .
37
+ * New function ` cyclonedx.builder.this.this_component() ` -- representation of this very python library as a ` Component ` .
38
+ * New function ` cyclonedx.builder.this.this_tool() ` -- representation of this very python library as a ` Tool ` .
39
+ * New function ` cyclonedx.model.tool.Tool.from_component() ` .
40
+
41
+ ### Dependencies
42
+
43
+ * Raised runtime dependency ` py-serializable>=1.1.1,<2 ` , was ` >=1.1.0,<2 ` .
44
+
45
+ ---------
46
+
47
+ Signed-off-by: Jan Kowalleck
< ; [email protected] > ;
48
+ Signed-off-by: Joshua Kugler
< ; [email protected] > ;
49
+ Signed-off-by: semantic-release
< ; [email protected] > ;
50
+ Co-authored-by: Joshua Kugler
< ; [email protected] > ;
51
+ Co-authored-by: semantic-release
< ; [email protected] > ; (
[ ` 002f966 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/002f96630ce8fc6f1766ee6cc92a16b35a821c69 ) )
21
52
22
- Signed-off-by: Jan Kowalleck & lt ; [email protected] & gt ; ( [ ` 1a24ee6 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/1a24ee6a0853e535465f85c6380971948281ad6e ) )
53
+ ### Documentation
23
54
24
- * Merge remote-tracking branch &# 39 ; origin/main &# 39 ; into 8.0.0-dev ( [ ` 4c57fa1 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/4c57fa156516de07cdd4acd3f3057c0b20d108d7 ) )
55
+ * docs(chaneglog): omit chore/ci/refactor/style/test/build ( # 703 )
25
56
57
+ Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` a210809 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/a210809efb34c2dc895fc0c6d96a3412a9097625 ) )
26
58
27
59
28
60
## v7.6.2 (2024-10-07)
@@ -43,126 +75,9 @@ fixes #690
43
75
44
76
Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` d8b20bd ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/d8b20bdc5224ea30cf767f6f3f1a6f8ff2754973 ) )
45
77
46
- ### Unknown
47
-
48
- * docs
49
-
50
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 68c681d ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/68c681d46c85230a97c4058de97400f3d93119f5 ) )
51
-
52
-
53
- ## v8.0.0-rc.2 (2024-09-27)
54
-
55
- ### Fix
56
-
57
- * fix: ToolRepository serialize migrated tools deduplicated (#686 )
58
-
59
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 35ccdd1 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/35ccdd1bfec9757457763308d16e1dbf5d9e28e9 ) )
60
-
61
- ### Unknown
62
-
63
- * docs
64
-
65
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 2e16408 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/2e16408098a3c649b80fb407d4f43aaa34aee39f ) )
66
-
67
- * rename ` ToolsRepository ` -> ; ` ToolRepository ` (#687 )
68
-
69
- Item class of repository is to be called in singular(` Tool ` ).
70
-
71
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` e00af17 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/e00af1739fa6d3933315e96266d96d9b290012ee ) )
72
-
73
-
74
- ## v8.0.0-rc.1 (2024-09-25)
75
-
76
- ### Documentation
77
-
78
- * docs: migrate to v8.0.0 (#684 )
79
-
80
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 0ac84d7 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/0ac84d76f2e526f329937ab004480405492e7417 ) )
81
-
82
- ### Fix
83
-
84
- * fix: assert copyright headers
85
-
86
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` bef268b ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/bef268b7abe2c3f343274d7789906c99c80e9df9 ) )
87
-
88
- ### Unknown
89
-
90
- * Merge branch ' ; main' ; into 8.0.0-dev
91
-
92
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 39514b3 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/39514b331eef98fbf5208ead341060831f8acddf ) )
93
-
94
- * Merge branch ' ; main' ; into 8.0.0-dev ([ ` c123aff ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/c123aff4bd479ec0f5f1982725ffe8901afb87c9 ) )
95
-
96
78
97
79
## v7.6.1 (2024-09-18)
98
80
99
- ### Breaking
100
-
101
- * feat!: this-builder (#649 )
102
-
103
- reworked ` ThisTool ` for #635
104
-
105
- ---------
106
-
107
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` cf5d2c7 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/cf5d2c7e43883967c5d5837f465ecac5a8cc034e ) )
108
-
109
- * refactor!: ` LicenseExpression() ` optional args are named args (#595 )
110
-
111
- fixes #594
112
-
113
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 0172564 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/0172564d5f9529e7ce543da434969b552833de31 ) )
114
-
115
- * feat!: Add component and services for tools (#635 )
116
-
117
- CycloneDX spec 1.5 deprecated an array of tools in bom.metadata and
118
- instead prefers object with an array of components and an array of
119
- services.
120
-
121
- This PR implements that.
122
-
123
- This works de-serializing a Syft SBOM with a tool section like so:
124
- ```
125
- "metadata": {
126
- "timestamp": "2024-06-10T13:06:52-08:00",
127
- "tools": {
128
- "components": [
129
- {
130
- "type": "application",
131
- "author": "anchore",
132
- "name": "syft",
133
- "version": "1.4.1"
134
- }
135
- ]
136
- },
137
- "component": {
138
- "bom-ref": "08329a07b4eb8eac",
139
- "type": "file",
140
- "name": "./"
141
- }
142
- },
143
- ```
144
- Next up: docs, XML (de)serialization code, and tests.
145
-
146
- fixes #561
147
-
148
- ---------
149
-
150
- Signed-off-by: Joshua Kugler
< ; [email protected] > ;
151
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ;
152
- Co-authored-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 1f5fd7a ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/1f5fd7a6be94d93d2260622d39ea01cd74614402 ) )
153
-
154
- * feat!: 8.0.0
155
-
156
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 9ba4b8e ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/9ba4b8e5d255c8dba51df214786328bfa700291c ) )
157
-
158
- ### Feature
159
-
160
- * feat: don' ; t add self to ` metafata.tools ` (#674 )
161
-
162
- fixes #673
163
-
164
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` e0a153f ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/e0a153fbd553dcf29343d72e361c1cc9122c63b4 ) )
165
-
166
81
### Fix
167
82
168
83
* fix: file copyright headers (#676 )
@@ -173,16 +88,6 @@ correct headers
173
88
174
89
Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 35e00b4 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/35e00b4ee5a9306b9e97b011025409bcbfcef309 ) )
175
90
176
- ### Unknown
177
-
178
- * Merge branch ' ; main' ; into 8.0.0-dev ([ ` 3d1548a ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/3d1548abf5db45764a22fcca96493574f96ff693 ) )
179
-
180
- * Merge branch ' ; main' ; into 8.0.0-dev
181
-
182
- Signed-off-by: Jan Kowalleck
< ; [email protected] > ; (
[ ` 735c800 ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/735c8003ce88b0c6efa802ccd806f17d22b4df89 ) )
183
-
184
- * Merge branch ' ; main' ; into 8.0.0-dev ([ ` 0ec785d ` ] ( https://github.com/CycloneDX/cyclonedx-python-lib/commit/0ec785d29abcc215a5a0f6feec9bf16b0994cc92 ) )
185
-
186
91
187
92
## v7.6.0 (2024-08-14)
188
93
0 commit comments