-
Notifications
You must be signed in to change notification settings - Fork 8
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
Add a test workflow #43
Conversation
Reviewer's Guide by SourceryThis pull request adds a new GitHub Actions workflow file to implement automated testing and linting for the project. The workflow is set up to run on push and pull request events for the master branch, as well as manual triggers. File-Level Changes
Tips
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @kgaughan - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider specifying the Rye version (0.36.0) in the test job for consistency with the lint job. This ensures the same version of Rye is used across all jobs.
- The use of Rye for Python environment management is an interesting choice. While it's a capable tool, it might be less familiar to some contributors. Consider documenting the reasons for choosing Rye and providing setup instructions for contributors who may be new to it.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
|
||
test: | ||
runs-on: ubuntu-latest | ||
strategy: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (performance): Consider adding caching for the test job to improve CI performance.
You're using caching for the lint job, but not for the test job. Adding caching for the test job could significantly speed up your CI pipeline, especially for repeated runs.
strategy:
matrix:
python-version:
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
0af4e6b
to
bcc7454
Compare
Summary by Sourcery
Introduce a GitHub Actions workflow to automate linting and testing for the project on the master branch.
CI: