Skip to content

Commit

Permalink
docs: migrate to v8.0.0
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
  • Loading branch information
jkowalleck committed Sep 23, 2024
1 parent 96386cc commit 1467b21
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/upgrading.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Upgrading to v8
===============

Version 8 is not backwards compatible. Some behaviours and integrations changed.
This document covers all breaking changes and should give guidance how to migrate from previous versions.

This document is not a full :doc:`change log <changelog>`, but a migration path.

____

Downstream users SHOULD add the following to their BOM build processes, to keep track of used libraries for potential troubleshooting:

```py
```
3 changes: 3 additions & 0 deletions examples/complex_serialize.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

from packageurl import PackageURL

from cyclonedx.builder.this import this_component as cdx_lib_component
from cyclonedx.exception import MissingOptionalDependencyException
from cyclonedx.factory.license import LicenseFactory
from cyclonedx.model import XsUri
Expand All @@ -43,6 +44,8 @@
# region build the BOM

bom = Bom()
bom.metadata.tools.components.add(cdx_lib_component())

bom.metadata.component = root_component = Component(
name='myApp',
type=ComponentType.APPLICATION,
Expand Down

0 comments on commit 1467b21

Please sign in to comment.