-
Notifications
You must be signed in to change notification settings - Fork 24
release: update README & bump to 2.0.1 #152
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
Conversation
📝 WalkthroughWalkthroughAdds a 2.0.1 (Unreleased) entry to CHANGELOG with a fixed note and updates README to deprecate most PostGIS schema methods, recommending Laravel’s built-in geometry/geography types while listing the remaining non-deprecated magellan types. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
34-41: Fix markdown list indentation (MD007) in the Table of Contents.markdownlint flags these as over-indented. Switch to two-space indentation for nested list items.
Apply this diff:
- - [Example Setup](#example-setup) - - [Insert/Update](#insertupdate) - - [Insert/Update with different SRID](#insertupdate-with-different-srid) - - [Select](#select) - - [Using PostGIS functions in queries](#using-postgis-functions-in-queries) - - [Alias in select](#alias-in-select) - - [Geometry or Geography](#geometry-or-geography) - - [Autocast for BBox or geometries](#autocast-for-bbox-or-geometries) + - [Example Setup](#example-setup) + - [Insert/Update](#insertupdate) + - [Insert/Update with different SRID](#insertupdate-with-different-srid) + - [Select](#select) + - [Using PostGIS functions in queries](#using-postgis-functions-in-queries) + - [Alias in select](#alias-in-select) + - [Geometry or Geography](#geometry-or-geography) + - [Autocast for BBox or geometries](#autocast-for-bbox-or-geometries) - - [Database Name Prepending (Cross Database Connections)](#database-name-prepending-cross-database-connections) + - [Database Name Prepending (Cross Database Connections)](#database-name-prepending-cross-database-connections)Also applies to: 43-43
136-151: Good: explicit list of non-deprecated schema methods; ensure consistency with examples elsewhere.This section clearly lists the supported magellan methods going forward. As a follow-up, audit remaining examples in the README that still use deprecated methods (e.g., table creation using magellanPoint) and either update them to Laravel’s native methods or label them as legacy.
I can sweep the README and propose a patch to replace or annotate deprecated usages for consistency. Want me to proceed?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
art/magellan_schema.pngis excluded by!**/*.png
📒 Files selected for processing (2)
CHANGELOG.md(1 hunks)README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
34-34: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🔇 Additional comments (2)
CHANGELOG.md (1)
10-15: Release entry looks good; ensure the 2.0.1 tag and GH release are created to avoid dead links.The 2.0.1 section is well-formed and fits Keep a Changelog. Once merged, make sure to push the git tag 2.0.1 and create the corresponding GitHub release so the link resolves.
Would you like me to draft the GitHub release notes using this CHANGELOG entry for the 2.0.1 tag?
README.md (1)
140-140: Validate the example syntax for Laravel’s native geometry column.The comment shows ->geometry('location', 'POINT', 4326). Verify this aligns with Laravel 11/12’s Blueprint API to avoid confusing users.
If confirmed otherwise, I can update the example to the correct signature across supported Laravel versions.
Updated the Readme to mention the new native Laravel Blueprint methods instead of ours and also removed some leftovers from v1.
Also marked the 2.0.1 release to get the last bugfix out :)
Summary by CodeRabbit