Skip to content

try sourcery#529

Closed
richm wants to merge 2 commits intolinux-system-roles:mainfrom
richm:try-sourcery
Closed

try sourcery#529
richm wants to merge 2 commits intolinux-system-roles:mainfrom
richm:try-sourcery

Conversation

@richm
Copy link
Copy Markdown
Contributor

@richm richm commented May 7, 2025

  • try with sourcery config file
  • move config file

Summary by Sourcery

Chores:

  • Create Sourcery configuration file with custom settings for code analysis

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 7, 2025

Reviewer's Guide

This pull request implements project-specific Sourcery configurations by introducing a .sourcery.yaml file. This file dictates how Sourcery analyzes the codebase by defining ignored paths, rule behaviors (e.g., disabling dict-literal and list-literal, targeting Python 3.6), quality thresholds, GitHub integration settings, and clone detection rules.

File-Level Changes

Change Details Files
Added Sourcery configuration file to customize code analysis.
  • Configured directory and file ignore patterns (e.g., .git, venv, node_modules).
  • Customized rule settings, enabling default rules, disabling specific ones like dict-literal and list-literal, and setting the Python version to 3.6.
  • Established a quality_threshold of 25.0 for code metrics.
  • Set up GitHub integration, including review requests to the author and a specific branch naming convention for Sourcery changes.
  • Defined parameters for code clone detection, such as minimum lines and duplicates.
.sourcery.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @richm - I've reviewed your changes - here's some feedback:

  • The configuration disables several common refactorings (e.g., list-literal, f-string conversions); ensure these choices are intentional and align with your project's style.
  • The configured Python version is 3.6; confirm this matches your project's minimum supported version or consider updating it if a newer version is used.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 10.72%. Comparing base (59fd1c6) to head (9bd7acc).
Report is 54 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (59fd1c6) and HEAD (9bd7acc). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (59fd1c6) HEAD (9bd7acc)
sanity 1 0
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #529      +/-   ##
==========================================
- Coverage   16.54%   10.72%   -5.83%     
==========================================
  Files           2        8       +6     
  Lines         284     1949    +1665     
  Branches       79        0      -79     
==========================================
+ Hits           47      209     +162     
- Misses        237     1740    +1503     
Flag Coverage Δ
sanity ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@richm richm closed this May 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant