Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: allow specifying the dependency depth resolution through CLI and make dependency resolution off by default #840

Merged
merged 16 commits into from
Sep 25, 2024

Conversation

tromai
Copy link
Member

@tromai tromai commented Aug 21, 2024

Closes #838 .

In this Pull Request I made the following changes:

  • 63b981d I refactor the dependency resolver base class so that it accepts whether it should analyze all transitive dependencies through a method parameter instead of the defaults.ini configuration.
[dependency.resolver] 
   recursive = True
  • 076318a I modified the Macaron's CLI to make --skip-deps an no-op. I also added --deps-depth as a new flag for setting the dependency resolution behavior (it's disabled by default).
  • a9dbacb, 41e6399, a85e855 I modified the existing test cases given the changes in Macaron's analyze command CLI.
  • d30215b I added new integration test cases on invalid usage of --deps-depth:
    • Providing invalid values to --deps-depth
    • Not setting --deps-depth when providing SBOM or Python Virtual Environment as input.
  • f2dde1f Update the Sphinx documentation accordingly.

@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Aug 21, 2024
@tromai tromai changed the title 838 make dependency resolution and analysis optional chore: make dependency resolution and analysis optional Aug 21, 2024
@tromai tromai changed the title chore: make dependency resolution and analysis optional feat!: allow specifying the dependency depth resolution through CLI and make dependency resolution off by default Aug 28, 2024
@tromai tromai force-pushed the 838-make-dependency-resolution-and-analysis-optional branch 2 times, most recently from a2d2f9c to f2dde1f Compare August 28, 2024 05:53
@tromai tromai marked this pull request as ready for review August 28, 2024 06:17
@tromai tromai requested a review from behnazh-w as a code owner August 28, 2024 06:17
@tromai tromai self-assigned this Aug 30, 2024
docs/source/pages/cli_usage/command_analyze.rst Outdated Show resolved Hide resolved
docs/source/pages/supported_technologies/index.rst Outdated Show resolved Hide resolved
docs/source/pages/using.rst Outdated Show resolved Hide resolved
src/macaron/__main__.py Outdated Show resolved Hide resolved
@tromai tromai force-pushed the 838-make-dependency-resolution-and-analysis-optional branch from f2dde1f to ab375ee Compare September 11, 2024 03:30
@tromai tromai force-pushed the 838-make-dependency-resolution-and-analysis-optional branch 2 times, most recently from 7d2ab75 to ac7639e Compare September 17, 2024 02:04
Copy link
Member

@behnazh-w behnazh-w left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The --skip-deps option is still mentioned in the usage documentation and various tutorials. Could you please remove these references and ensure that the remaining text remains clear and coherent?

@tromai tromai force-pushed the 838-make-dependency-resolution-and-analysis-optional branch from ac7639e to 8b6ceac Compare September 24, 2024 06:50
@tromai
Copy link
Member Author

tromai commented Sep 24, 2024

The --skip-deps option is still mentioned in the usage documentation and various tutorials. Could you please remove these references and ensure that the remaining text remains clear and coherent?

I have removed the remaining --skip-deps in this commit 8b6ceac.
The only places where --skip-deps exists are within __main__.py and command_analyze.rst. In all cases, there are DEPRECATED messages.

@tromai tromai merged commit 38387e4 into staging Sep 25, 2024
10 checks passed
@tromai tromai deleted the 838-make-dependency-resolution-and-analysis-optional branch September 25, 2024 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants