Skip to content

Commit 427ac61

Browse files
authored
cyclone (#4391)
1 parent 53e1764 commit 427ac61

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

reference/extensions/deployers.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,22 @@ Files are only included in environment generators when correctly specified throu
7171
and ``cpp_info.libdirs`` configuration.
7272

7373

74+
.. _reference_extensions_deployer_cyclone:
75+
76+
cyclone_1.6 and cyclone_1.4
77+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
78+
79+
The ``cyclone_1.6`` and ``cyclone_1.4`` deployers are available to generate a CycloneDX 1.6 or 1.4 SBOM file
80+
respectively, with the information of the dependencies in the graph.
81+
The generated file will be named ``sbom-cyclonedx-1.{6, 4}.json`` and it will be located in the deployer output folder.
82+
These deployers will use the ``cyclonedx_1_6`` and ``cyclonedx_1_4`` functions from the :ref:`conan.tools.sbom.cyclonedx<conan_tools_sbom>` module
83+
with default arguments.
84+
85+
If you want to customize the generated SBOM, you can either create your own custom deployer
86+
that calls these functions with the desired arguments,
87+
or use the documented hook approach from the previous link to generate the SBOM.
88+
89+
7490
configuration
7591
^^^^^^^^^^^^^
7692

reference/tools/sbom.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@ Remember to enable the option if you wish to add any of them to your SBOM!
2626
.. seealso::
2727

2828
- :ref:`Software Bills of Materials (SBOM) <security_sboms>`.
29+
- :ref:`Generate SBOMs with the built-in deployers<reference_extensions_deployer_cyclone>`.

0 commit comments

Comments
 (0)