Add comprehensive tenancy package documentation to boost resources#1461
Open
eramitgupta wants to merge 5 commits into
Open
Add comprehensive tenancy package documentation to boost resources#1461eramitgupta wants to merge 5 commits into
eramitgupta wants to merge 5 commits into
Conversation
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR adds comprehensive documentation for the ChangesTenancy Laravel Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@resources/boost/skills/tenancy/references/package.md`:
- Around line 295-326: The reference lists two inconsistent command names
(`tenants:create-user-with-rls-policies` vs `tenants:rls`); pick a single
canonical name (e.g., `tenants:rls`) and update all occurrences so both the
bullet command list and the notes section use that same symbol; ensure any
explanatory text that mentions creating the RLS user or policies references the
chosen command (`tenants:rls` or `tenants:create-user-with-rls-policies`)
consistently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 91f7b086-179d-406f-98e7-b4c893e9f9d3
📒 Files selected for processing (2)
resources/boost/skills/tenancy/SKILL.mdresources/boost/skills/tenancy/references/package.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1461 +/- ##
=========================================
Coverage 85.90% 85.90%
Complexity 1170 1170
=========================================
Files 185 185
Lines 3412 3412
=========================================
Hits 2931 2931
Misses 481 481 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@resources/boost/guidelines/core.blade.php`:
- Line 776: Update the documentation entry that currently shows the wrong
Artisan command name "tenant:dump" to the correct command "tenants:dump"; search
for any other occurrences of "tenant:dump" in the same template and replace them
with "tenants:dump" so the example matches the package command referenced in the
PR.
In `@resources/boost/skills/tenancy/references/installation.md`:
- Around line 22-49: Update the numbered ordered list in the installation steps
so every list item uses "1." (rather than mixing numbering styles) to satisfy
markdownlint MD029; specifically change the step numbers for the sequence that
includes the installer command "php artisan tenancy:install --no-interaction",
the confirmation list of files (`config/tenancy.php`, `routes/tenant.php`,
`app/Providers/TenancyServiceProvider.php`, migration filenames and
`database/migrations/tenant`), the "Review `config/tenancy.php`" line, the "Run
central migrations" block (`php artisan migrate`), and subsequent steps ("Add
tenant migrations...", "Create tenants and domains...", "Run tenant migrations")
so each step begins with "1." for consistent, lint-compliant numbering.
In `@resources/boost/skills/tenancy/references/migrations-commands.md`:
- Around line 35-40: Update the documented Artisan command name in the snippet:
change the incorrect "php artisan tenant:dump" to the correct "php artisan
tenants:dump" so the commands list uses "php artisan tenants:run cache:clear",
"php artisan tenant:tinker", "php artisan tenants:list", and "php artisan
tenants:dump" (fix the single-line entry referring to tenant:dump to
tenants:dump).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 70126611-d45e-4b9c-ac86-18868dc10fda
📒 Files selected for processing (21)
resources/boost/guidelines/core.blade.phpresources/boost/skills/tenancy/SKILL.mdresources/boost/skills/tenancy/references/bootstrappers.mdresources/boost/skills/tenancy/references/configuration.mdresources/boost/skills/tenancy/references/context-api.mdresources/boost/skills/tenancy/references/database-tenancy.mdresources/boost/skills/tenancy/references/features.mdresources/boost/skills/tenancy/references/filesystem-cache-queue.mdresources/boost/skills/tenancy/references/identification.mdresources/boost/skills/tenancy/references/impersonation.mdresources/boost/skills/tenancy/references/installation.mdresources/boost/skills/tenancy/references/integrations.mdresources/boost/skills/tenancy/references/lifecycle-jobs.mdresources/boost/skills/tenancy/references/migrations-commands.mdresources/boost/skills/tenancy/references/models-domains.mdresources/boost/skills/tenancy/references/package.mdresources/boost/skills/tenancy/references/pending-tenants.mdresources/boost/skills/tenancy/references/resource-syncing.mdresources/boost/skills/tenancy/references/rls.mdresources/boost/skills/tenancy/references/routing-assets.mdresources/boost/skills/tenancy/references/testing.md
…h focused references
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
Adds Laravel Boost skill resources for
stancl/tenancy.Notes
Summary by CodeRabbit