PHPackages pixelated-au/streamline - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [DevOps & Deployment](/categories/devops) 4. / 5. pixelated-au/streamline ActiveLibrary[DevOps & Deployment](/categories/devops) pixelated-au/streamline ======================= Self-update your Laravel deployment 0236[1 PRs](https://github.com/pixelated-au/streamline/pulls)PHPCI passing Since Apr 18Pushed 1mo ago1 watchersCompare [ Source](https://github.com/pixelated-au/streamline)[ Packagist](https://packagist.org/packages/pixelated-au/streamline)[ RSS](/packages/pixelated-au-streamline/feed)WikiDiscussions main Synced today READMEChangelogDependenciesVersions (4)Used By (0) Streamline: Self-update your Laravel deployment =============================================== [](#streamline-self-update-your-laravel-deployment) [![GitHub Tests Action Status](https://camo.githubusercontent.com/a56f8e14a9b2296aae0d79223cfe1a0be02ad3c89c6b52e6adf848e312d1310c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f706978656c617465642d61752f73747265616d6c696e652f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/pixelated-au/streamline/actions?query=workflow%3Arun-tests+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/d71c596d597c23a7f637915d1b585b9193cf2409089c40bc2678f9dfbdd2ccfb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f706978656c617465642d61752f73747265616d6c696e652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/pixelated-au/streamline) This specialised tool is designed to help you self-update your Laravel deployment directly from GitHub. *This project assumes your package includes all built front-end JavaScript assets.* Using artisan, you can update the package via the CLI or a tool such as Laravel Envoy. Installation ------------ [](#installation) During beta, you can install the package via composer: ``` composer require pixelated-au/streamline:dev-main ``` You can publish the config file with: ``` php artisan vendor:publish --tag="streamline-config" ``` You will need to set the following environment variables in your `.env` file. - Replace \[github\] and \[project-name\] with your GitHub repository. - Version installed is the version of the package that is currently installed. It will be set automatically. ``` STREAMLINE_GITHUB_RELEASE_REPOSITORY=[github]/[project-name] STREAMLINE_APPLICATION_VERSION_INSTALLED=v0.0.0 ``` Events ------ [](#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 --------------- [](#artisan-console) There are several Artisan commands that you can interact with: - `streamline:check` Check for an available update - `streamline:clean-assets` Tidy up the front-end build assets directory. Default values are configured in config/streamline.php. This can be set using a schedule - `streamline:list` Retrieves the available updates from GitHub and stores them in the cache - `streamline:run-update` CLI update of the software. Make sure to back up first! Questions --------- [](#questions) #### What is the point of this project? [](#what-is-the-point-of-this-project) Unlike other updater projects available (which are excellent by the way), this runs an update by calling an external PHP script/class. For performance reasons, Laravel loads classes dynamically. If updating directly within Laravel, the application may fail to load classes that have been removed/deprecated causing the update to fail, leaving a broken site. This project runs an update by calling an external PHP script/class, ensuring that during the update, there is an extremely low chance of the update failing. #### Why is does this project assume all front-end assets will be pre-compiled? [](#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? [](#does-this-need-composer-installed-or-how-do-i-run-composer-to-install-dependencies) Yes, Composer is required to install dependencies. It happens automatically as part of the update. #### Who is this for? [](#who-is-this-for) 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? [](#whos-it-not-for) If you have a project being deployed onto virtual machines inside 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 either do a pull request or extend it locally in your project. #### Extending/Customising [](#extendingcustomising) Streamline is built upon a pipeline architecture, so you can inject your own steps into the update process. For example, if you wish to make it build your front-end assets instead of using pre-built assets, you can create a new pipeline step. Use the config file `config/streamline.php` to customise the update process to suit your needs. You can also create your own implementation of `Pixelated\Streamline\Interfaces\UpdateBuilderInterface` which is the tool to progressively gather information about the update process before the final update is run. Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. TODO ---- [](#todo) - Detect if the GitHub token has expired. If so, output an error to the user License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE) for more information. ### Health Score 26 — LowBetter than 41% of packages Maintenance59 Moderate activity, may be stable Popularity13 Limited adoption so far Community20 Small or concentrated contributor base Maturity16 Early-stage or recently created project Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://avatars.githubusercontent.com/u/2679520?v=4)[Ian Heggaton](/maintainers/pixelated-au)[@pixelated-au](https://github.com/pixelated-au) --- Top Contributors [![pixelated-au](https://avatars.githubusercontent.com/u/2679520?v=4)](https://github.com/pixelated-au "pixelated-au (455 commits)")[![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (365 commits)")[![mvdnbrk](https://avatars.githubusercontent.com/u/802681?v=4)](https://github.com/mvdnbrk "mvdnbrk (46 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (26 commits)")[![Nielsvanpach](https://avatars.githubusercontent.com/u/10651054?v=4)](https://github.com/Nielsvanpach "Nielsvanpach (23 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (19 commits)")[![pforret](https://avatars.githubusercontent.com/u/474312?v=4)](https://github.com/pforret "pforret (16 commits)")[![sebastiandedeyne](https://avatars.githubusercontent.com/u/1561079?v=4)](https://github.com/sebastiandedeyne "sebastiandedeyne (14 commits)")[![patinthehat](https://avatars.githubusercontent.com/u/5508707?v=4)](https://github.com/patinthehat "patinthehat (10 commits)")[![riasvdv](https://avatars.githubusercontent.com/u/3626559?v=4)](https://github.com/riasvdv "riasvdv (9 commits)")[![crynobone](https://avatars.githubusercontent.com/u/172966?v=4)](https://github.com/crynobone "crynobone (8 commits)")[![AdrianMrn](https://avatars.githubusercontent.com/u/12762044?v=4)](https://github.com/AdrianMrn "AdrianMrn (8 commits)")[![AlexVanderbist](https://avatars.githubusercontent.com/u/6287961?v=4)](https://github.com/AlexVanderbist "AlexVanderbist (7 commits)")[![thecaliskan](https://avatars.githubusercontent.com/u/13554944?v=4)](https://github.com/thecaliskan "thecaliskan (5 commits)")[![irfanm96](https://avatars.githubusercontent.com/u/42065936?v=4)](https://github.com/irfanm96 "irfanm96 (5 commits)")[![IGedeon](https://avatars.githubusercontent.com/u/694313?v=4)](https://github.com/IGedeon "IGedeon (4 commits)")[![yaroslawww](https://avatars.githubusercontent.com/u/23663794?v=4)](https://github.com/yaroslawww "yaroslawww (3 commits)")[![jessarcher](https://avatars.githubusercontent.com/u/4977161?v=4)](https://github.com/jessarcher "jessarcher (3 commits)")[![koossaayy](https://avatars.githubusercontent.com/u/6431084?v=4)](https://github.com/koossaayy "koossaayy (3 commits)")[![lloricode](https://avatars.githubusercontent.com/u/8251344?v=4)](https://github.com/lloricode "lloricode (3 commits)") ### Embed Badge ![Health badge](/badges/pixelated-au-streamline/health.svg) ``` [![Health](https://phpackages.com/badges/pixelated-au-streamline/health.svg)](https://phpackages.com/packages/pixelated-au-streamline) ``` ### Alternatives [in2code/in2publish_core Content publishing extension to connect stage and production server 40143.4k](/packages/in2code-in2publish-core)[tiamo/phpas2 PHPAS2 is a php-based implementation of the EDIINT AS2 standard 4778.9k](/packages/tiamo-phpas2)[wapmorgan/php-rpm-packager RPM packager for PHP applications. 106.6k](/packages/wapmorgan-php-rpm-packager) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)