Skip to content

Commit 0caee7d

Browse files
author
Trong Nhan Mai
committed
chore: update sphinx documentation for the use case of SBOM without main software component's repository available
1 parent 19ba5bb commit 0caee7d

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/source/pages/cli_usage/action_verify-policy.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
.. Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
22
.. Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
33
4+
.. _verify-policy-action-cli:
5+
46
=============
57
Verify Policy
68
=============

docs/source/pages/using.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,23 @@ With the example above, the generated output reports can be seen here:
191191
- `micronaut-core.html <../_static/examples/micronaut-projects/micronaut-core/analyze_with_sbom/micronaut-core.html>`__
192192
- `micronaut-core.json <../_static/examples/micronaut-projects/micronaut-core/analyze_with_sbom/micronaut-core.json>`__
193193

194+
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
195+
Analyzing dependencies in the SBOM without the main software component
196+
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
197+
198+
In the case where the repository URL of the main software component is not available (e.g. the repository is in a private domain where Macaron cannot access),
199+
Macaron can still run the analysis on the dependencies listed in the SBOM.
200+
To do that, you must first create a PURL to present the main software component. This is so that this software component could be referenced later in the :ref:`verify-policy <verify-policy-action-cli>` command.
201+
For example: ``pkg:private_domain.com/org/name``.
202+
203+
Then the analysis can be run with:
204+
205+
.. code-block:: shell
206+
207+
./run_macaron.sh analyze -purl pkg:private_domain.com/org/name -sbom <path_to_sbom>
208+
209+
With ``path_to_sbom`` is the path to the SBOM you want to use.
210+
194211
'''''''''''''''''''''''''''
195212
Analyzing more dependencies
196213
'''''''''''''''''''''''''''

0 commit comments

Comments
 (0)