README

What does it do?
Project Structure
Task's documentation
Composer
- Available settings
Changelog

What does it do?

Library with some additional tasks for deployer (deployer.org).

Project Structure

The project is organized into two main directories:

deployer/

Contains files (tasks/settings) that are safe to be loaded as until explicitly used they do not affect Deployer. So even if you use two tasks from deployer/ folder you can load whole directory safely. Tasks are set to be hidden by default so they will not pollute Deployer task list.
includes/

Contains files that should be included selectively in your deployment process. Unlike the functionality in the deployer/ directory, these components can override default Deployer functionality (for example override bin/composer setting in Deployer).

Check if the branch you want to deploy is different from the branch currently deployed on host. If you have information that the branch on the host is different than the branch you want to deploy then you can take decision to overwrite it or not.

deploy:check_branch_local

Check if the branch you are currently checked out on your local is the same branch you want to deploy. The deploy.php files on both branches can be different and that can influence the deploy process.

deploy:check_composer_install

Check if there is composer.lock file on current instance and if its there then make dry run for composer install. If composer install returns information that some packages needs to be updated or installed then it means that probably developer pulled composer.lock changes from repo but forget to make composer install. In that case deployment is stopped to allow developer to update packages, make some test and make deployment then.

deploy:check_composer_validate

Check if composer.lock file is up to date with current state of composer.json. In not then deployment is stopped.

deploy:check_lock

Checks for existence of file deploy.lock in root of current instance. If the file deploy.lock is there then deployment is stopped. You can use it for whatever reason you have. Needed mainly if you do development from local and not from CI.

file

file:backup

Creates backup of files. Single task may perform multiple archivization using defined filters. Old ones are deleted after executing this task. Default limit is 5.

Configuration description

file_backup_packages required: yes default value: none type: array
Packages definition
file_backup_keep required: no default value: 5 type: int
Limit of backups per package

Example configuration:

set('file_backup_packages', [
    'config' => [
        '-path "./etc/*"',
    ],
    'translations' => [
        '-path "./l10n/*"',
        '-path "./modules/*/l10n/*"',
    ],
    'small_images' => [
        [ '-path "./media/uploads/*"', '-size -25k' ],
        [ '-path "./media/theme/*"', '-size -25k' ],
    ],
]);

set('file_backup_keep', 10);

Config variable file_backup_packages stores information about backup packages and files filtering options. Each package defines filters which will be used in find command. First level element are groups which will be concatenated using logical alternative operator operator OR. If group is array type then group elements will be concatenated using logical conjunction operator.

Package config: It is simplest definition. For this package all files from directory ./etc/ will be backuped.

Package translations: For this one all files from directory ./l10n/ will be backuped. It will also include files from all l10n/ from "modules" subdirectory. For example modules/cookies/l10

Package small_images: This one will contain all small (smaller than 25kB) files from "media/uploads" and "media/theme".

As you can see file_backup_keep is set to 10 which means only newest 10 backups per package will be stored.

file:copy_dirs_ignore_existing

Copy directories from previous release except for those directories which already exists in new release.

file:copy_files_ignore_existing

Copy files from previous release except for those files which already exists in new release.

file:upload_build

Upload files not defined in clear_paths, shared_files, shared_dirs. Can be used as good default for uploading build from CI.

cache

cache:clear_php_cli

This task clears the file status cache, opcache and eaccelerator cache for CLI context.

cache:clear_php_http

This task clears the file status cache, opcache and eaccelerator cache for HTTP context. It does following:

Creates file cache_clear_[random].php in {{deploy_path}}/current folder.
Fetch this file with selected method - curl / wget / file_get_contents - by default its wget.
The file is not removed after clearing cache for reason. It allows to prevent problems with realpath_cache.

You must set public_urls configuration variable so the script knows the domain it should fetch the php script. Here is example:

host('staging')
 ->setHostname('vm-dev.example.com')
 ->setRemoteUser('project1')
 ->set('public_urls', ['https://staging-t3base13.example.com'])
 ->set('deploy_path', '~/t3base13.example.com/staging');

Task configuration variables:

cache:clear_php_http:phpcontent required: no type: string default value:
```
<?php
  clearstatcache(true);
  if(function_exists('opcache_reset')) opcache_reset();
  if(function_exists('eaccelerator_clear')) eaccelerator_clear();
```
Php content that will be put into dynamically created file that should clear the caches.
public_urls required: yes default value: none type: array
Domain used to prepare url to fetch clear cache php file. Its expected to be array so you can put there more than one domain and use it for different purposes but here for this task the first domain will be taken.
fetch_method required: no default value: wget type: string
Can be one of following value: - curl, - wget, - file_get_contents
cache:clear_php_http:timeout required: no default value: 15 type: integer
Set the timeout in seconds for fetching php clear cache script.

sourcebroker / deployer-extended

Maintainers

Details

README

What does it do?

Project Structure

Task's documentation

deploy

deploy:check_branch

deploy:check_branch_local

deploy:check_composer_install

deploy:check_composer_validate

deploy:check_lock

file

file:backup

file:copy_dirs_ignore_existing

file:copy_files_ignore_existing

file:upload_build

cache

cache:clear_php_cli

cache:clear_php_http

Composer

Available settings

composer_version

composer_channel

composer_channel_autoupdate

Changelog