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

Create python-package.yml #741

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

Conversation

ATMFEEDME20z
Copy link

@ATMFEEDME20z ATMFEEDME20z commented Oct 26, 2024

Summary by Sourcery

CI:

  • Add a GitHub Actions workflow to automate testing and linting for Python packages across multiple Python versions.

Copy link
Contributor

sourcery-ai bot commented Oct 26, 2024

Reviewer's Guide by Sourcery

This PR adds a GitHub Actions workflow configuration file that sets up automated testing and linting for a Python project. The workflow runs on Ubuntu and tests against Python versions 3.9, 3.10, and 3.11.

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

File-Level Changes

Change Details Files
Added a new GitHub Actions workflow for Python package testing
  • Configures workflow to trigger on push and pull requests to main branch
  • Sets up matrix testing for Python versions 3.9, 3.10, and 3.11
  • Installs project dependencies and testing tools (flake8, pytest)
  • Implements flake8 linting with syntax error checks and style warnings
  • Adds pytest execution step for running tests
.github/workflows/python-package.yml

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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
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 @ATMFEEDME20z - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider upgrading actions/setup-python from v3 to v4 to get the latest features and security updates
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟡 Testing: 1 issue found
  • 🟢 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.

steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
Copy link
Contributor

Choose a reason for hiding this comment

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

🚨 suggestion (security): Consider upgrading to actions/setup-python@v4

Version 4 includes security updates and performance improvements that would benefit the workflow.

Suggested change
uses: actions/setup-python@v3
uses: actions/setup-python@v4

strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10", "3.11"]
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (testing): Consider adding Python 3.12 to the test matrix

Python 3.12 is now stable and adding it would ensure compatibility with the latest Python version.

Suggested change
python-version: ["3.9", "3.10", "3.11"]
python-version: ["3.9", "3.10", "3.11", "3.12"]

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