Artisan Io Laravel Package

Getting Started

• Confirm your app runs Laravel 7 or 8 before adopting v3.0.0:
  • php artisan --version
  • Check composer.json for laravel/framework constraint.
• Require the v3 line explicitly, e.g. composer require vendor/package:^3.0.
• If you are still on Laravel 5, do not upgrade this package; stay on the previous major until the app is upgraded. Laravel 6 support is not stated in the release notes, so verify the package’s composer.json before assuming compatibility.
• First places to look:
  • Package composer.json for PHP/Laravel constraints.
  • README installation and configuration sections.
  • Service provider and config file, if published.
  • Any migrations, routes, commands, or facade aliases.
• First practical use case: install v3 in a Laravel 8 app, publish any config, run the package’s basic documented flow, and add one smoke test around that flow before rolling it into production code.

Implementation Patterns

• Pin to ^3.0 in Laravel 7/8 projects rather than using a floating constraint. This keeps the Laravel 5 drop from affecting older applications unexpectedly.
• Rely on Laravel package discovery for service providers and aliases unless the package docs explicitly require manual registration.
• Publish config only where needed, then move environment-specific values into .env or deployment config. Avoid editing vendor files.
• Inject package services/contracts into your own application services where possible. Use facades only for short, local calls; wrapping package calls in your own service/action layer reduces upgrade surface for future majors.
• In queued jobs, console commands, and scheduled tasks, verify the package config is loaded before the job runs and that cached config is refreshed during deployment.
• Add at least one integration test that exercises the package’s core path. If your codebase supports both Laravel 7 and 8, run CI against both versions.
• Use composer why-not vendor/package ^3.0 when Composer refuses the upgrade; this quickly exposes Laravel, PHP, or transitive dependency conflicts.

Gotchas and Tips

• v3.0.0 is a breaking release for Laravel 5 users. Do not attempt to install it on a Laravel 5 app; stay on the prior major and plan the framework upgrade separately.
• Laravel 6 is not mentioned in the release notes. Treat it as unsupported unless the package metadata proves otherwise.
• Major version upgrades often change PHP requirements too. Check the package composer.json, not just the Laravel constraint.
• After upgrading, clear cached config and package discovery:
  • php artisan config:clear
  • php artisan package:discover
• If you publish config or assets, diff the new default config against your published copy. New major versions may add, rename, or remove keys.
• Watch for stale composer.lock conflicts in CI. Run a clean composer update vendor/package in a branch and review the lock diff.
• Extension points to check before customizing internals: published config, container bindings, facades, events, and any documented custom implementations. Prefer these over subclassing vendor code.
• If the package provides migrations, review them before running in production and confirm whether they are publishable or auto-loaded.