Skip to content

fix: SP-2339 Fix wfp command loading settings file from cwd #114

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

matiasdaloia
Copy link
Contributor

@matiasdaloia matiasdaloia commented Apr 11, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Corrected an issue where configuration settings were loaded from the wrong directory, ensuring the correct source is used.
  • Documentation
    • Updated the changelog with the new release version and a reference link for comparing changes between releases.
  • Chores
    • Upgraded the software version from 1.20.6 to 1.20.7.

@matiasdaloia matiasdaloia self-assigned this Apr 11, 2025
@matiasdaloia matiasdaloia requested a review from eeisegn April 11, 2025 08:02
@matiasdaloia matiasdaloia added the bug Something isn't working label Apr 11, 2025
Copy link

coderabbitai bot commented Apr 11, 2025

Walkthrough

This pull request updates the software to version 1.20.7. The changelog now documents a fix for the wfp command, ensuring the settings file is loaded from the scan root directory rather than from the current working directory. The update includes modifications to the CLI and settings-loading functions, with improved type annotations and streamlined error handling.

Changes

File(s) Summary
CHANGELOG.md, src/scanoss/__init__.py Updated version to 1.20.7. Added a new changelog entry with a fix for the wfp command and a reference link for comparing versions.
src/scanoss/cli.py, src/scanoss/scanoss_settings.py Modified the wfp command to pass an additional scan_dir argument to load_json_file. Updated the method signature and type annotations in scanoss_settings.py, and streamlined error handling logic with a simplified membership test.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant SettingsLoader as ScanossSettings
    User->>CLI: Execute "wfp" command with settings & scan_dir
    CLI->>SettingsLoader: load_json_file(settings, scan_dir)
    SettingsLoader-->>CLI: Return settings (or raise ScanossSettingsError)
    CLI-->>User: Display success message or error notification
Loading

Poem

I’m a rabbit hopping through lines of code,
Skipping errors and fixes in my abode.
New paths revealed for settings to load,
From scan roots instead of the default road.
With each update, my whiskers twitch in delight,
Celebrating fresh updates, day or night! 🐰

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@matiasdaloia matiasdaloia force-pushed the fix/mdaloia/SP-2339-scanoss-py-wfp-trying-to-load-settings-from-local-directory branch from 80eb310 to 82f0ec2 Compare April 11, 2025 08:07
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
CHANGELOG.md (1)

12-15: Clarify and Verify the [1.20.7] Entry

The new version entry for [1.20.7] - 2025-04-11 clearly documents the fix addressing the wfp command settings file loading logic. Please double-check for any accidental word duplication as flagged by static analysis—even if it might be a false positive—to ensure the text is free of typos.

🧰 Tools
🪛 LanguageTool

[duplication] ~13-~13: Possible typo: you repeated a word.
Context: ...hanges... ## [1.20.7] - 2025-04-11 ### Fixed - Fixed issue with wfp command where settings f...

(ENGLISH_WORD_REPEAT_RULE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 80eb310 and 82f0ec2.

📒 Files selected for processing (4)
  • CHANGELOG.md (2 hunks)
  • src/scanoss/__init__.py (1 hunks)
  • src/scanoss/cli.py (3 hunks)
  • src/scanoss/scanoss_settings.py (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • src/scanoss/init.py
  • src/scanoss/cli.py
  • src/scanoss/scanoss_settings.py
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[duplication] ~13-~13: Possible typo: you repeated a word.
Context: ...hanges... ## [1.20.7] - 2025-04-11 ### Fixed - Fixed issue with wfp command where settings f...

(ENGLISH_WORD_REPEAT_RULE)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (1)
CHANGELOG.md (1)

497-498: Ensure Correctness of Reference Links

The reference links for [1.20.6] and [1.20.7] appear to follow the established URL pattern and version sequencing. Verify that these URLs correctly reflect the intended commit comparisons between versions. This consistency is crucial for users to trace changes through the history.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant