deployer/docs/recipe/common.md

Common Recipe

require 'recipe/common.php';

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. :::info Autogenerated The value of this configuration is autogenerated on access. :::

keep_releases

Source

Number of releases to preserve in releases folder.

10

repository

Source

Repository to deploy.

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

deploy_path

Source

The deploy path.

For example can be set for a bunch of host once as:

set('deploy_path', '~/{{alias}}');

:::info Required Throws exception if not set. :::

current_path

Source

Return current release path. Default to deploy_path/current.

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

'{{deploy_path}}/current'

bin/php

Source

Path to the php bin.

if (currentHost()->hasOwn('php_version')) {
return '/usr/bin/php{{php_version}}';
}
return which('php');

bin/git

Source

Path to the git bin.

return which('git');

use_relative_symlink

Source

Should bin/symlink use --relative option or not. Will detect automatically.

return commandSupportsOption('ln', '--relative');

bin/symlink

Source

Path to the ln bin. With predefined options -nfs.

return get('use_relative_symlink') ? 'ln -nfs --relative' : 'ln -nfs';

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. :::info Autogenerated The value of this configuration is autogenerated on access. :::

Tasks

deploy:prepare

Source

Prepares a new release.

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

Publishes the release.

This task is group task which contains next tasks:

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

deploy

Source

Deploys your project.

This task is group task which contains next tasks:

• deploy:prepare
• deploy:publish

deploy:success

Source

Prints success message

deploy:failed

Source

Hook on deploy failure.

logs:app

Source

Shows application logs.

Follows latest application logs.