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(templates): Add pytest-github-actions-annotate-failures for GitHub workflows of tap, target and mapper templates #2872

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Feb 5, 2025

Summary by Sourcery

Adds pytest-github-actions-annotate-failures to the test dependencies of tap, target, and mapper templates, and updates the minimum required version of tox.

New Features:

  • Adds pytest-github-actions-annotate-failures to the test dependencies of tap, target, and mapper templates, enabling automatic annotation of test failures in GitHub Actions workflows.

Enhancements:

  • Updates the minimum required version of tox to 4.22 in tap, target and mapper templates.
  • Adds test dependency group to dev dependency group in tap, target and mapper templates.

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

Copy link
Contributor

sourcery-ai bot commented Feb 5, 2025

Reviewer's Guide by Sourcery

This pull request adds the pytest-github-actions-annotate-failures dependency to the tap, target, and mapper templates for GitHub workflows. It also updates tox.ini to use dependency groups and requires tox>=4.22. The pytest-github-actions-annotate-failures dependency is added to the test dependency group in pyproject.toml when GitHub CI files are included in the template.

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

File-Level Changes

Change Details Files
Added pytest-github-actions-annotate-failures as a test dependency when GitHub CI files are included in the template.
  • Added pytest-github-actions-annotate-failures>=0.3 to the test dependency group in pyproject.toml for tap templates.
  • Added pytest-github-actions-annotate-failures>=0.3 to the test dependency group in pyproject.toml for target templates.
  • Added pytest-github-actions-annotate-failures>=0.3 to the test dependency group in pyproject.toml for mapper templates.
cookiecutter/mapper-template/{{cookiecutter.mapper_id}}/pyproject.toml
cookiecutter/tap-template/{{cookiecutter.tap_id}}/pyproject.toml
cookiecutter/target-template/{{cookiecutter.target_id}}/pyproject.toml
Updated tox.ini to use dependency groups and require tox>=4.22.
  • Updated tox.ini to use dependency groups for tap templates.
  • Updated tox.ini to use dependency groups for target templates.
  • Updated tox.ini to use dependency groups for mapper templates.
  • Set minversion = 4.22 in tox.ini for tap templates.
  • Set minversion = 4.22 in tox.ini for target templates.
  • Set minversion = 4.22 in tox.ini for mapper templates.
cookiecutter/mapper-template/{{cookiecutter.mapper_id}}/tox.ini
cookiecutter/tap-template/{{cookiecutter.tap_id}}/tox.ini
cookiecutter/target-template/{{cookiecutter.target_id}}/tox.ini

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 Feb 5, 2025
@edgarrmondragon edgarrmondragon force-pushed the 2721-featci-github-test-workflow-annotations-for-userwarnings-and-possibly-other-cases branch 2 times, most recently from 8012f89 to fab41f1 Compare February 5, 2025 19:12
…tHub workflows of tap, target and mapper templates
@edgarrmondragon edgarrmondragon force-pushed the 2721-featci-github-test-workflow-annotations-for-userwarnings-and-possibly-other-cases branch from fab41f1 to ffef3c6 Compare February 5, 2025 20:02
@edgarrmondragon edgarrmondragon added this to the v0.45 milestone Feb 5, 2025
@edgarrmondragon edgarrmondragon added testing Dependencies Cookiecutter Tap, target and mapper templates labels Feb 25, 2025
@edgarrmondragon edgarrmondragon marked this pull request as ready for review February 25, 2025 14:47
@edgarrmondragon edgarrmondragon requested a review from a team as a code owner February 25, 2025 14: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 - here's some feedback:

Overall Comments:

  • Consider adding a comment to explain why tox>=4.22 is required.
  • It might be worth extracting the conditional pytest-github-actions-annotate-failures dependency into a separate group to avoid repetition.
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 618bc8d into main Feb 25, 2025
10 checks passed
@edgarrmondragon edgarrmondragon deleted the 2721-featci-github-test-workflow-annotations-for-userwarnings-and-possibly-other-cases branch February 25, 2025 15:04
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 Dependencies testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(ci): GitHub test workflow annotations for UserWarnings (and possibly other cases)
1 participant