Download the PHP package pixelated-au/streamline without Composer
On this page you can find all versions of the php package pixelated-au/streamline. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pixelated-au/streamline
More information about pixelated-au/streamline
Files in pixelated-au/streamline
Package streamline
Short Description For this package there is no description available.
License
Informations about the package streamline
Streamline: Self-update your Laravel deployment
This specialised tool is designed to help you self-update your Laravel deployment directly from GitHub.
Unlike other tools, this project assumes your package includes all built assets and composer vendor packages.
Using artisan, you can update the package via the CLI or a tool such as Laravel Envoy.
Installation
You can install the package via composer:
You can publish the config file with:
Events
This library emits two events for hooking into updates:
\Pixelated\Streamline\Events\AvailableVersionsUpdated
Emits when it's pulled down the available versions from GitHub\Pixelated\Streamline\Events\InstalledVersionSet
Emits when the current, installed version has been set\Pixelated\Streamline\Events\NextAvailableVersionUpdated
Emits when the next available version has been set
Artisan Console
There are several Artisan commands that you can interact with:
streamline:check
Check for an available updatestreamline:clean-assets
Tidy up the front-end build assets directory. Default values are configured in config/streamline.php. This can be set using a schedulestreamline:list
Retrieves the available updates from GitHub and stores them in the cachestreamline:run-update
CLI update of the software. Make sure to back up first!
Common Questions
Why is does this project assume all front-end assets will be pre-compiled? : To bypass any potential compilation needs. Building a release of a project using something like CI or doing it locally ensures that when it's deployed, there are no post-processing requirements. For example, you don't need to have NPM or Node installed. You don't need to worry about the version of Node that's installed either. It simplifies updates
Does this need Composer installed? OR How do I run Composer to install dependencies? : Whilst technically you can utilise Composer after an update, this package doesn't support it. The reasoning being the same as the previous answer on front-end-assets. When we don't depend on Composer as part of the installation process, we won't get build errors during an upgrade.
Who is this for? : First up, it's not for all projects! It was built so that a project could be deployed on single-instance machines, not unlike upgrading a WordPress instance. It's designed to simplify deployment - moving the build/dependency mechanics into a centralised place such as CI. For example, this could be used inside a cPanel hosting environment.
Who's it not for? : If you have a project being deployed onto virtual machines inside of dedicated environments, other 'updater' projects may suit your needs more than this project. That said, this project was designed with extensibility in mind. As such, if you're keen to extend it, you can eiter do a pull request or extend it locally in your project.
What other whizzbang features does this have? : Unlike other updater projects available (which are excellent by the way), this runs an update by calling an external PHP script/class. This ensures that during the update, the only classes loaded into memory are directly attached to this project.
: As part of its optimisation techniques, Laravel (and potentially child libraries) doesn't load all classes into memory. This is great except when after an update, Laravel may try to load said classes. Again, not a problem... except if those classes have been removed/deprecated! If that happens, the deployment will halt/fail and will require manual work. Not good if you want a self-maintainable product!
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Pixelated
- All Contributors
License
The MIT License (MIT). Please see License File for more information.