Download the PHP package jtmcc/atomic-deployments without Composer
On this page you can find all versions of the php package jtmcc/atomic-deployments. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jtmcc/atomic-deployments
More information about jtmcc/atomic-deployments
Files in jtmcc/atomic-deployments
Package atomic-deployments
Short Description Local zero downtime deployments for Laravel applications
License MIT
Informations about the package atomic-deployments
Atomic Deployment Package for Laravel Framework
The purpose of this package is to introduce local zero-downtime deployments into a laravel application.
Requirements
- Laravel 7 | 8
- PHP ^7.4 | ^8.0
Installation
Configuration
.env
There are three required environment variables:
- ATM_DEPLOYMENT_LINK: The symbolic link you will use with your web server, artisan schedules, ...etc
- ATM_BUILD: The project build folder where you will run composer, any build related logic, update your env
- ATM_DEPLOYMENTS: The root folder that builds will be deployed to and linked
config( ...)
By default, this package will restrict your project to 10 deployment builds. Once you hit the limit defined in the config, older deployments will be automatically deleted. Be aware of the size of your project and adjust to meet your needs.
You might find yourself in a situation where you need to migrate files that don't exist in your build project from your current deployment folder to your new deployment folder. These files/folders can be specified in the migrate config array, and they will be copied from the outgoing deployment into the new deployment when you run the deploy command.
Once you have configured your env and have deployed a build, you can update your webserver to start routing traffic to your 'deployment-link' location.
Commands
atomic-deployments:deploy
options
- --hash= : Specify a previous deployments commit hash/deploy-dir to deploy
- --directory= : Define your deploy folder name. Defaults to current HEAD hash
- --dry-run : Test and log deployment steps
examples
Do a dry run to get some feedback on the steps that will be taken
Deploy current build using the current branch git hash for deployment folder
Deploy current build using a custom directory name
Revert linked project back to a previous build
atomic-deployments:list
Prints a table to the console of the currently available builds
examples
Events
- DeploymentSuccessful
- DeploymentFailed
Laravel Forge Example
Here is a basic configuration for use with Forge
Deploy Script
.env
Build project .env
nginx config
schedule command
If your application is isolated, you must ensure that your deployments folder has the appropriate permissions to serve your application for that user.
License
MIT