docs: add instructions on using repo finder #350
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -110,12 +110,30 @@ With the example above, the generated output reports can be seen here: | |
| - `micronaut-core.html <../_static/examples/micronaut-projects/micronaut-core/analyze_with_sbom/micronaut-core.html>`__ | ||
| - `micronaut-core.json <../_static/examples/micronaut-projects/micronaut-core/analyze_with_sbom/micronaut-core.json>`__ | ||
|
|
||
| ''''''''''''''''''''''''''' | ||
| Analyzing more dependencies | ||
| ''''''''''''''''''''''''''' | ||
|
|
||
| In some cases the dependencies that Macaron discovers lack a direct connection to a repository for it to analyze. To improve results in these instances, the Repository Finding feature can be enabled. This feature makes use of a dependency's identifying information that can be found using the package registries located on the Internet. | ||
|
|
||
| .. note:: The Repository Finding feature currently only works for Java projects via SCM meta data found within artifact POM files. | ||
|
|
||
| This feature is enabled by default. To disable, or configure its behaviour in other ways, a custom ``defaults.ini`` should be passed to Macaron during execution. Under the ``repofinder.java`` header, five options exist: ``find_repos``, ``artifact_repositories``, ``repo_pom_paths``, ``find_parents``, ``artifact_ignore_list``. These options behave as follows: | ||
|
|
||
| - ``find_repos`` (Values: True or False) - Enables or disables the Repository Finding feature. | ||
| - ``artifact_repositories`` (Values: List of URLs) - Determines the remote artifact repositories to attempt to retrieve dependency information from. | ||
| - ``repo_pom_paths`` (Values: List of POM tags) - Determines where to search for repository information in the POM files. E.g. scm.url. | ||
| - ``find_parents`` (Values: True or False) - When enabled, the Repository Finding feature will also search for repository URLs in parents POM files of the current dependency. | ||
| - ``artifact_ignore_list`` (Values: List of GAs) - The Repository Finding feature will skip any artifact in this list. Format is "GroupId":"ArtifactId". E.g. org.apache.maven:maven | ||
|
|
||
| .. note:: Finding repositories requires at least one remote call, adding some additional overhead to an analysis run. | ||
|
|
||
behnazh-w marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ------------------------------------- | ||
| Analyzing a locally cloned repository | ||
| ------------------------------------- | ||
|
|
||
| If you have a local repository that you want to analyze, Macaron also supports running the analysis against a local repository. | ||
| '''''''''''''''''' | ||
|
There was a problem hiding this comment. Looks like this line is added accidentally and is causing an error: https://github.com/oracle/macaron/actions/runs/5450632046/jobs/9916079385?pr=350#step:8:9763 |
||
| Assume that the dir tree at the local repository has the following components: | ||
|
|
||
| .. code-block:: shell | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be helpful to add a reference like this:
You need to add a reference in
docs/source/pages/cli_usage/action_dump_defaults.rstbutanalyze-action-clireference already exists.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've tried to. Not sure if it's displaying as it should be though.