deployer/docs/recipe/common.md

common

Source

• Requires
  • provision
  • check_remote
  • cleanup
  • clear_paths
  • copy_dirs
  • info
  • lock
  • push
  • release
  • rollback
  • setup
  • shared
  • symlink
  • update_code
  • vendors
  • writable

Configuration

user

Source

Name of current user who is running deploy. If not set will try automatically get git user name, otherwise output of whoami command.

keep_releases

Source

Number of releases to preserve in releases folder.

10

repository

Source

Repository to deploy.

shared_dirs

Source

List of dirs what will be shared between releases. Each release will have symlink to those dirs stored in {{deploy_path}}/shared dir.

set('shared_dirs', ['storage']);

shared_files

Source

List of files what will be shared between releases. Each release will have symlink to those files stored in {{deploy_path}}/shared dir.

set('shared_files', ['.env']);

copy_dirs

Source

List of dirs to copy between releases. For example you can copy node_modules to speedup npm install.

clear_paths

Source

List of paths to remove from release_path.

clear_use_sudo

Source

Use sudo for deploy:clear_path task?

false

use_relative_symlink

Source

use_atomic_symlink

Source

default_timeout

Source

Default timeout for run() and runLocally() functions.

Set to null to disable timeout.

300

env

Source

Remote environment variables.

set('env', [
    'KEY' => 'something',
]);

It is possible to override it per run() call.

run('echo $KEY', ['env' => ['KEY' => 'over']]

dotenv

Source

Path to .env file which will be used as environment variables for each command per run().

set('dotenv', '{{current_path}}/.env');

false

current_path

Source

Return current release path. Default to {{deploy_path}}/current.

set('current_path', '/var/public_html');

'{{deploy_path}}/current'

sudo_askpass

Source

Path to a file which will store temp script with sudo password. Defaults to .dep/sudo_pass. This script is only temporary and will be deleted after sudo command executed.

target

Source

The deploy target: a branch, a tag or a revision.

Tasks

deploy:prepare

Source

This task is group task which contains next tasks:

• deploy:info
• deploy:setup
• deploy:lock
• deploy:release
• deploy:update_code
• deploy:shared
• deploy:writable

deploy:publish

Source

This task is group task which contains next tasks:

• deploy:symlink
• deploy:unlock
• deploy:cleanup
• deploy:success

deploy:success

Source

Prints success message

deploy:failed

Source

Hook on deploy failure.

logs

Source

Follow latest application logs.

Follow latest application logs.