Document 1.13.x vs 1.x maintenance lines in README#91
Merged
Conversation
Explain that the choice between lines is driven by whether the application uses Doctrine annotations (1.13.x via ray/di ^2.13) or PHP attributes only (1.x via ray/di ^2.16+), and that PHP version requirements come from the Aura.Sql major. Include a tilde/wildcard constraint example since ^1.13 would upgrade to the 1.x line.
PHP 8.4's PDO BC break is why 6.x exists; 5.x covers 8.1-8.3. Drop the standalone PHP version table since composer picks the matching Aura.Sql major from the PHP version, and the real decision for users is annotations vs attributes.
Member
Author
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideDocuments the two parallel 1.x maintenance lines in the README, clarifying how to choose between them (annotations vs attributes) and how to correctly pin Composer constraints to stay on 1.13.x. Flow diagram for selecting version line and Composer constraintflowchart TD
A["Start"] --> B["Does_application_use_Doctrine_annotations_in_docblocks?"]
B -->|Yes| C["Select_version_line_1_13_x"]
B -->|No,_uses_PHP_attributes| D["Select_version_line_1_x_current"]
C --> E["Set_Composer_requirement_ray_aura_sql_module_to_tilde_or_wildcard_for_1_13_x_e_g_~1_13_1"]
D --> F["Set_Composer_requirement_ray_aura_sql_module_to_1_x_range"]
E --> G["Composer_resolves_Aura_Sql_major_from_PHP_version"]
F --> G
G --> H["Install_dependencies_with_selected_line"]
H --> I["End"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdded a "Versions" section to README documenting two maintained release lines for ray/aura-sql-module: 1.13.x for Doctrine docblock annotations and 1.x for PHP attributes only, with their respective dependencies and Aura.Sql compatibility. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The wording around "1.13.x" vs "1.x (current)" is a bit ambiguous; consider clarifying explicitly which 1.x versions are attribute-only (e.g., "1.14+" or similar) so readers don’t have to infer the cutoff.
- In the Composer constraint explanation, the phrase "pull you onto the 1.x line" could be clearer, since
1.13.xis also in the 1.x series; consider rephrasing to something like "would also match 1.14+ and therefore upgrade you to the attribute-only releases."
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The wording around "1.13.x" vs "1.x (current)" is a bit ambiguous; consider clarifying explicitly which 1.x versions are attribute-only (e.g., "1.14+" or similar) so readers don’t have to infer the cutoff.
- In the Composer constraint explanation, the phrase "pull you onto the 1.x line" could be clearer, since `1.13.x` is also in the 1.x series; consider rephrasing to something like "would also match 1.14+ and therefore upgrade you to the attribute-only releases."Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 1.x #91 +/- ##
===========================================
Coverage 100.00% 100.00%
Complexity 142 142
===========================================
Files 41 41
Lines 505 505
===========================================
Hits 505 505 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Versionssection to README explaining the two maintenance lines^1.13would pull onto 1.x and show~1.13.1as the correct pinBackground
1.13.xdepends onray/di^2.13, which still shipsdoctrine/annotations, so Doctrine-style@Transactionalkeeps working1.xdepends onray/di^2.16+, wheredoctrine/annotationswas dropped — PHP attributes onlyTest plan
~1.13.1locks to 1.13.x;^1.13does not)Summary by Sourcery
Document the two maintained 1.x release lines and their selection criteria in the README, clarifying annotation vs attribute usage, Aura.Sql/PHP version implications, and providing example Composer constraints.
Documentation:
Summary by CodeRabbit