How to perform different tasks with Deployer.
You can run dep list to view available commands.
- Get information about deployments
- Deploying
- Rolling back
- Viewing logfiles
- Synching files
- SSH to a remote server
To view what was last deployed to an environment:
dep show <environment>
To view a list of releases:
dep releases <environment>
To find out what tasks will run for a deployment add the --plan option:
dep deploy --plan staging
To run a deployment:
dep deploy <environment>
By default, this will deploy to the default branch (main / master).
E.g.
dep deploy production
To specify a branch use:
dep deploy <environment> --branch=<branch name>
E.g.
dep deploy staging --branch=feature/new-thing
Please note you cannot deploy non-default branches to production unless you pass the --force option.
If you want to find out what tasks run for a deployment:
dep tree deploy
Rollback to the last deployment via:
dep rollback <environment>
E.g. to rollback production to the last release:
dep rollback production
Deployer defines application logfiles in the log_files configuration setting. This can be one or multiple log files.
View a log file via:
dep logs:view
See logs for more information.
To sync files locally you need to setup sync settings in your deploy.php file.
You can run sync via:
dep sync <name>
E.g.
dep sync images
If you only have one sync setup, or you want to run the first sync task, then you don't need to pass a name.
See sync documentation.
Connect to a remote server via:
dep ssh <environment> E.g. to connect to staging:
dep ssh staging
You can check if your SSH connection is working via:
dep check:ssh <environment>