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 1006a99 commit f351a2d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-o
contributing
support
changelog
upgrading
11 changes: 7 additions & 4 deletions docs/upgrading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ to keep track of used libraries during the build process.
bom = Bom()
bom.metadata.tools.components.add(cdx_lib_component())
Import model `Tool`
-------------------
Import model Tool
-----------------

Class `cyclonedx.model.Tool` was moved to :class:`cyclonedx.model.tool.Tool`.
Therefore, the imports need to be altered:
Expand All @@ -35,7 +35,7 @@ New: ``from cyclonedx.model.tool import Tool``
Altering Metadata Tools
-----------------------

:prop:`cyclonedx.mode.bom.BomMetaData.tool` is an instance of :class:`cyclonedx.model.tool.ToolsRepository`, now.
Property :attr:`cyclonedx.model.bom.BomMetaData.tools` is an instance of :class:`cyclonedx.model.tool.ToolsRepository`, now.
Therefore, the process of adding new tools was changed.

Old: ``my_bom.metadata.tools.add(my_tool)``
Expand All @@ -45,13 +45,16 @@ New: ``my_bom.metadata.tools.tools.add(my_tool)``
Altering Metadata Tools
-----------------------

:prop:`cyclonedx.mode.vulnerability.Vulnerability.tools` is an instance of :class:`cyclonedx.model.tool.ToolsRepository`, now.
Property :attr:`cyclonedx.model.vulnerability.Vulnerability.tools` is an instance of :class:`cyclonedx.model.tool.ToolsRepository`, now.
Therefore, the process of adding new tools was changed.

Old: ``my_vulnerability.tools.add(my_tool)``

New: ``my_vulnerability.tools.tools.add(my_tool)``

Setting LicenseExpression Acknowledgement
-----------------------------------------

:class:`cyclonedx.model.license.LicenseExpression()` no longer accepts optional arguments in a positional way, but in a key-word way.

Old: ``LicenseExpression(my_exp, my_acknowledgement)``
Expand Down

0 comments on commit f351a2d

Please sign in to comment.