docs: add instructions on using repo finder #350
Merged
Conversation
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
Signed-off-by: Ben Selwyn-Smith <[email protected]>
oracle-contributor-agreement
bot
added
the
OCA Verified
behnazh-w
reviewed
Jun 30, 2023
tromai
reviewed
Jun 30, 2023
Signed-off-by: Ben Selwyn-Smith <[email protected]>
behnazh-w
reviewed
Jul 4, 2023
docs/source/pages/using.rst
Outdated
Comment on lines
172
to
174
| --------------------------- | ||
| Analyzing more dependencies | ||
| --------------------------- |
There was a problem hiding this comment.
I think it would be better to move this section as a subsection of Analyzing with an SBOM. What do you think?
Signed-off-by: Ben Selwyn-Smith <[email protected]>
behnazh-w
reviewed
Jul 4, 2023
docs/source/pages/using.rst
Outdated
| ------------------------------------- | ||
| 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
Signed-off-by: Ben Selwyn-Smith <[email protected]>
behnazh-w
reviewed
Jul 4, 2023
docs/source/pages/using.rst
Outdated
|
|
||
| .. 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: |
There was a problem hiding this comment.
It would be helpful to add a reference like this:
See :ref:`dump-defaults <reference to docs/source/pages/cli_usage/action_dump_defaults.rst >`, the CLI command to dump the default configurations in ``defaults.ini``. After making changes, see :ref:`analyze <analyze-action-cli>` CLI command for the option to pass the modified ``defaults.ini`` file.
You need to add a reference in docs/source/pages/cli_usage/action_dump_defaults.rst but analyze-action-cli reference already exists.
There was a problem hiding this comment.
I've tried to. Not sure if it's displaying as it should be though.
tromai
reviewed
Jul 4, 2023
Signed-off-by: Ben Selwyn-Smith <[email protected]>
Signed-off-by: Ben Selwyn-Smith <[email protected]>
behnazh-w
approved these changes
Jul 5, 2023
tromai
approved these changes
Jul 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds instructions for using the repo finder feature to the "using" docs page.