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

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

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Feb 5, 2025

Summary by Sourcery

Add pytest-github-actions-annotate-failures dependency to tap, target, and mapper templates for GitHub workflows. Update tox.ini to use dependency groups and require tox>=4.22.

Build:

  • Update tox.ini to use dependency groups and require tox>=4.22.

Tests:

  • Add pytest-github-actions-annotate-failures dependency to GitHub workflows.

📚 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 package to the test dependencies of the tap, target, and mapper templates. It also updates the tox configuration files to use dependency_groups instead of deps and sets the minimum tox version to 4.22.

Class diagram for template dependency structure

classDiagram
    class Template {
        +dependency_groups
        +test_dependencies
        +tox_config
    }

    class DependencyGroups {
        +dev: group
        +test: group
    }

    class TestDependencies {
        +pytest: >=8
        +singer_sdk: [testing]
        +pytest_github_actions_annotate_failures: >=0.3
    }

    class ToxConfig {
        +minversion: 4.22
        +requires: tox>=4.22
        +dependency_groups: test
    }

    Template *-- DependencyGroups
    Template *-- TestDependencies
    Template *-- ToxConfig

    note for Template "Applied to tap, target, and mapper templates"
Loading

File-Level Changes

Change Details Files
Add pytest-github-actions-annotate-failures to test dependencies.
  • Add pytest-github-actions-annotate-failures>=0.3 to the test dependency group when cookiecutter.include_ci_files is GitHub.
cookiecutter/tap-template/{{cookiecutter.tap_id}}/pyproject.toml
cookiecutter/mapper-template/{{cookiecutter.mapper_id}}/pyproject.toml
cookiecutter/target-template/{{cookiecutter.target_id}}/pyproject.toml
Update tox configuration to use dependency_groups and set minimum tox version.
  • Set minversion = 4.22 in the tox section.
  • Replace deps with dependency_groups = test in the testenv section.
  • Update tox requirement to tox>=4.22
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
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.

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