feat: support testing on diff python versions #56
Conversation
shenxianpeng
changed the title
shenxianpeng
force-pushed
the
feature/test-on-diff-python
branch
from
424b673 to
d9f9041
Compare
shenxianpeng
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #56 +/- ##
=======================================
Coverage 85.71% 85.71%
=======================================
Files 3 3
Lines 77 77
=======================================
Hits 66 66
Misses 11 11 ☔ View full report in Codecov by Sentry. |
github-actions
bot
added
the
documentation
|
WalkthroughThis pull request introduces comprehensive updates across multiple configuration files to enhance Python version compatibility and testing strategies. The changes span the GitHub Actions workflow, project configuration, documentation, and version tracking. The modifications aim to broaden Python version support, improve testing coverage, and clarify project metadata, with a focus on supporting Python versions from 3.8 to 3.14. Changes
Sequence DiagramsequenceDiagram
participant Workflow as GitHub Actions
participant Python as Python Versions
participant Test as Test Job
participant Coverage as Codecov
Workflow->>Python: Select Python version
Python-->>Test: Run tests
alt Python version is 3.13
Test->>Coverage: Generate coverage report
else
Test->>Test: Skip coverage
end
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/workflows/test.yml (1)
Line range hint
37-42: Consider documenting the Codecov version selectionThe choice to run Codecov only on Python 3.13 is reasonable to avoid redundant coverage reports. However, it would be helpful to document why this specific version was chosen.
Consider adding a comment explaining the version selection:
- uses: codecov/codecov-action@v5 - if: matrix.python-version == '3.13' + if: matrix.python-version == '3.13' # Run coverage only once on a stable recent version with: token: ${{ secrets.CODECOV_TOKEN }} files: ./coverage.xmlREADME.md (1)
133-133: Consider a more formal tone in the Contributing sectionThe current wording could be more professional while maintaining enthusiasm.
Consider revising to:
- We welcome contributions! Whether it's fixing issues, suggesting improvements, or submitting pull requests, your support is greatly appreciated. + We welcome contributions. Whether it's resolving issues, suggesting improvements, or submitting pull requests, your support is greatly appreciated.🧰 Tools
🪛 LanguageTool
[style] ~133-~133: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 1841 characters long)
Context: ...# Contributing We welcome contributions! Whether it's fixing issues, suggesting ...(EN_EXCESSIVE_EXCLAMATION)
[style] ~133-~133: Consider using a different verb for a more formal wording.
Context: ... We welcome contributions! Whether it's fixing issues, suggesting improvements, or sub...(FIX_RESOLVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/workflows/test.yml(2 hunks).gitignore(1 hunks)README.md(5 hunks)pyproject.toml(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- .gitignore
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~133-~133: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 1841 characters long)
Context: ...# Contributing We welcome contributions! Whether it's fixing issues, suggesting ...
(EN_EXCESSIVE_EXCLAMATION)
[style] ~133-~133: Consider using a different verb for a more formal wording.
Context: ... We welcome contributions! Whether it's fixing issues, suggesting improvements, or sub...
(FIX_RESOLVE)
🔇 Additional comments (3)
pyproject.toml (1)
5-5: LGTM: Python version requirement is well-specified
The minimum Python version requirement of 3.8 is reasonable as it's still receiving security updates.
.github/workflows/test.yml (1)
13-15: LGTM: Comprehensive Python version testing strategy
The matrix strategy effectively covers both stable and development Python versions. Using a specific alpha version (3.14.0-alpha.2) is a good practice for reproducible testing.
README.md (1)
3-4: LGTM: Clear version support indication
The addition of the Python version badge and the updated PyPI badge effectively communicate the package's version support to users.
shenxianpeng
removed
the
documentation
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores
.gitignoreto exclude the.venvdirectory.pyproject.toml.