docs: expand upgrade guide (2.x → 3.0) with breaking changes and legacy note - #27
Merged
Conversation
…y note - Before/after examples for each breaking change - Explicit note that 1.x remains available and compatible with PHP 5.4+ - Deprecations table and summary of what's new in v2 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WvDYWr2Tx3diCV3NXGrKRX
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughREADME.md updates legacy PHP/Laravel version pinning and replaces the former 1.x upgrade notes with v3.0 guidance covering compatibility, breaking changes, deprecations, and new components. Changesv3.0 upgrade documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
The package already had 2.0.4–2.2.0 tags on Packagist (PHP 5.4+ era), so the modernized release must be v3.0.0 and the upgrade guide now points legacy users to ^2.2 instead of ^1.0. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WvDYWr2Tx3diCV3NXGrKRX
gdespirito
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 368-370: Update the “What’s new in v2” section to make each listed
feature directly link to its corresponding documentation section or anchor,
including Rut enhancements, Iva, Clp, Phone, Region, Comuna, the cl_phone rule,
Rules\Rut, RutCast, and Laravel integration; avoid relying only on the phrase
“documented above.”
- Around line 334-336: Clarify the Laravel compatibility statement in the “PHP
8.2+ (and Laravel 11+) required” section: align it with the actual supported
Laravel range based on the package’s composer requirements and APIs, or add an
explicit Laravel 11+ constraint in composer.json if that minimum is intentional.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+368
to
+370
| ### What's new in v2 | ||
|
|
||
| Besides the modernized `Rut` (with `Rut::check()`, `Rut::random()`, `RutFormat` enum, `Stringable`/`JsonSerializable`), v2 adds `Iva`, `Clp`, `Phone`, `Region` and `Comuna`, plus the `cl_phone` validation rule, the `Rules\Rut` rule object and the `RutCast` Eloquent cast — all documented above. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Link the listed v2 features to their documentation.
The objective calls for feature-documentation links, but these feature names are plain text and only refer readers to “documented above.” Add direct links or anchors for the listed packages, rules, cast, and Laravel integration.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 368 - 370, Update the “What’s new in v2” section to
make each listed feature directly link to its corresponding documentation
section or anchor, including Rut enhancements, Iva, Clp, Phone, Region, Comuna,
the cl_phone rule, Rules\Rut, RutCast, and Laravel integration; avoid relying
only on the phrase “documented above.”
…hors Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WvDYWr2Tx3diCV3NXGrKRX
Member
Author
|
Addressed both findings: the README now states Laravel 10+ (the contracts we rely on — |
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.
Expands the "Upgrading" section of the README and fixes the release numbering:
2.0.4–2.2.0series on Packagist (tags withoutvprefix, PHP 5.4+ era). The modernized release is therefore v3.0.0, not v2.0.0 — the erroneousv2.0.0release/tag (which collided with the old2.0tag) was deleted.composer require freshwork/chilean-bundle:^2.2pin).format()throwing,vnSeparator()type fix).scape_chars(), legacy facade).🤖 Generated with Claude Code
https://claude.ai/code/session_01WvDYWr2Tx3diCV3NXGrKRX
Summary by CodeRabbit
freshwork/chilean-bundleversion.format()/normalize()now throwInvalidFormatExceptionfor invalid RUTs when exceptions are enabled, whilequiet()retains the priorfalsebehavior.vnSeparator()now accepts astring, and expanded the deprecations table and “What’s new” coverage.