Skip to content

Commit 1467b21

Browse files
committed
docs: migrate to v8.0.0
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 96386cc commit 1467b21

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/upgrading.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Upgrading to v8
2+
===============
3+
4+
Version 8 is not backwards compatible. Some behaviours and integrations changed.
5+
This document covers all breaking changes and should give guidance how to migrate from previous versions.
6+
7+
This document is not a full :doc:`change log <changelog>`, but a migration path.
8+
9+
____
10+
11+
Downstream users SHOULD add the following to their BOM build processes, to keep track of used libraries for potential troubleshooting:
12+
13+
```py
14+
15+
16+
```

examples/complex_serialize.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
from packageurl import PackageURL
2222

23+
from cyclonedx.builder.this import this_component as cdx_lib_component
2324
from cyclonedx.exception import MissingOptionalDependencyException
2425
from cyclonedx.factory.license import LicenseFactory
2526
from cyclonedx.model import XsUri
@@ -43,6 +44,8 @@
4344
# region build the BOM
4445

4546
bom = Bom()
47+
bom.metadata.tools.components.add(cdx_lib_component())
48+
4649
bom.metadata.component = root_component = Component(
4750
name='myApp',
4851
type=ComponentType.APPLICATION,

0 commit comments

Comments
 (0)