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: Fix local SDK use in cookiecutter tests #2864

Merged

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Jan 31, 2025


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

Summary by Sourcery

Tests:

  • Improve cookiecutter tests.

@edgarrmondragon edgarrmondragon self-assigned this Jan 31, 2025
@edgarrmondragon edgarrmondragon added the Cookiecutter Tap, target and mapper templates label Jan 31, 2025
Copy link
Contributor

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request modifies the cookiecutter tests to use the local singer-sdk instead of installing it from PyPI. It also updates the GitHub Actions workflow to reflect these changes.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Use local singer-sdk for cookiecutter tests.
  • The test now uses the local singer-sdk by adding it as a dependency using uv add.
  • The test no longer modifies the pyproject.toml file to point to the local singer-sdk.
  • The test now uses uv tool run to execute twine and pre-commit.
noxfile.py
Update GitHub Actions workflow to use uv for pre-commit and twine.
  • The workflow no longer installs pre-commit and twine directly.
  • The workflow now relies on uv to manage these tools.
.github/workflows/cookiecutter-e2e.yml
Use Path objects for file paths in cookiecutter tests.
  • The replay_file_path parameter in the test_cookiecutter function is now a Path object.
  • The template variable is now a Path object.
noxfile.py
Use session.create_tmp() to create temporary directory.
  • The cc_build_path variable is now created using session.create_tmp() instead of tempfile.gettempdir().
noxfile.py
Use uv for dependency management.
  • The test now uses uv to lock and sync dependencies.
  • The test now uses uv to build the project.
noxfile.py
Use a list for nox sessions.
  • The nox.options.sessions is now a list instead of a tuple.
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

Copy link

codspeed-hq bot commented Jan 31, 2025

CodSpeed Performance Report

Merging #2864 will not alter performance

Comparing edgarrmondragon/ci/fix-local-sdk-cookiecutter-tests (9c586c4) with main (8e297df)

Summary

✅ 7 untouched benchmarks

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 (052c491) to head (9c586c4).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2864   +/-   ##
=======================================
  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.

noxfile.py Outdated Show resolved Hide resolved
@edgarrmondragon edgarrmondragon marked this pull request as ready for review January 31, 2025 19:47
@edgarrmondragon edgarrmondragon requested a review from a team as a code owner January 31, 2025 19:47
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 edgarrmondragon merged commit a3a3a84 into main Jan 31, 2025
32 checks passed
@edgarrmondragon edgarrmondragon deleted the edgarrmondragon/ci/fix-local-sdk-cookiecutter-tests branch January 31, 2025 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cookiecutter Tap, target and mapper templates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant