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

chore: Require uv be used with Nox #2866

Merged
merged 4 commits into from
Jan 31, 2025

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Jan 31, 2025

Summary by Sourcery

Require the use of uv for virtual environment management in Nox sessions and across all GitHub Actions workflows.

Build:

  • Install Nox using uv tool install instead of pipx.
  • Pin Nox version to 2024.10.9.
  • Remove pip from dependencies and constraints.

CI:

  • Use uv to manage virtual environments in GitHub Actions workflows.
  • Set the UV_CONSTRAINT environment variable to the project's requirements file.
  • Set the UV_VERSION environment variable to 0.5.26.
  • Use setup-uv action to set up uv.

📚 Documentation preview 📚: https://meltano-sdk--2866.org.readthedocs.build/en/2866/

Copy link
Contributor

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request enforces the use of uv as the virtual environment backend for Nox, updates CI to use uv for installing Nox and setting up the environment, and removes pip upgrades.

Flow diagram: Updated CI Environment Setup Process

flowchart TD
    A[Start CI Job] --> B[Setup Python]
    B --> C[Setup uv v0.5.26]
    C --> D[Install Nox using uv]
    D --> E[Run Nox sessions]

    style C fill:#90EE90
    style D fill:#90EE90
Loading

File-Level Changes

Change Details Files
Enforce uv as the virtual environment backend for Nox.
  • Set nox.options.default_venv_backend to uv.
noxfile.py
Update CI to use uv for installing Nox and setting up the environment.
  • Install Nox using uv tool install instead of pipx.
  • Use astral-sh/setup-uv@v5 to set up uv.
  • Set the UV_VERSION environment variable.
  • Set the UV_CONSTRAINT environment variable.
.github/workflows/test.yml
.github/workflows/api-changes.yml
.github/workflows/cookiecutter-e2e.yml
Remove pip upgrade step and related caching.
  • Remove the pip upgrade step.
  • Remove the pip constraint environment variable.
  • Remove pip from the requirements file.
.github/workflows/test.yml
.github/workflows/api-changes.yml
.github/workflows/cookiecutter-e2e.yml
.github/workflows/resources/requirements.txt
Update coverage data artifact name.
  • Remove SQLAlchemy version from the coverage data artifact name.
.github/workflows/test.yml
Use uv to run griffe in api_changes session.
  • Use uv tool run to execute griffe.
noxfile.py

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@edgarrmondragon edgarrmondragon self-assigned this Jan 31, 2025
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.34%. Comparing base (df11728) to head (e0661e8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2866   +/-   ##
=======================================
  Coverage   91.34%   91.34%           
=======================================
  Files          62       62           
  Lines        5209     5209           
  Branches      673      673           
=======================================
  Hits         4758     4758           
  Misses        319      319           
  Partials      132      132           

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

Copy link

codspeed-hq bot commented Jan 31, 2025

CodSpeed Performance Report

Merging #2866 will not alter performance

Comparing edgarrmondragon/chore/nox-require-uv (e0661e8) with main (df11728)

Summary

✅ 7 untouched benchmarks

@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/chore/nox-require-uv branch from 82b1601 to a7c82a7 Compare January 31, 2025 22:36
@edgarrmondragon edgarrmondragon marked this pull request as ready for review January 31, 2025 22:45
@edgarrmondragon edgarrmondragon requested a review from a team as a code owner January 31, 2025 22:45
@edgarrmondragon edgarrmondragon merged commit 1d00bfc into main Jan 31, 2025
37 checks passed
@edgarrmondragon edgarrmondragon deleted the edgarrmondragon/chore/nox-require-uv branch January 31, 2025 22:45
Copy link
Contributor

@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 @edgarrmondragon - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: 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.

edgarrmondragon added a commit that referenced this pull request Jan 31, 2025
* chore: Require uv be used with Nox

* Use uv more broadly

* Move `UV_CONSTRAINT` to the top

* Remove redundant installation of griffe
edgarrmondragon added a commit that referenced this pull request Jan 31, 2025
* chore: Require uv be used with Nox

* Use uv more broadly

* Move `UV_CONSTRAINT` to the top

* Remove redundant installation of griffe
edgarrmondragon added a commit that referenced this pull request Feb 5, 2025
* chore: Require uv be used with Nox

* Use uv more broadly

* Move `UV_CONSTRAINT` to the top

* Remove redundant installation of griffe
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