README

Additional and enhanced tasks not available for Deployer out of the box.

Installation

composer require friemt/deployer-tasks

Usage

Either include the recipe or task and the respective configuration to your deployer file.

crontab

Syncs configured cronjobs to the target systems.

# deploy.php
# ...

import('recipe/crontab.php');
# or
import('task/crontab.php');

# See `src/examples/crontab.yaml` for a yaml based example file.
import(__DIR__ . '/<path-to-configs>/crontab.yaml');

# When using the task instead of the recipe, add the sync task to the deployment manually:
after('deploy:symlink', 'crontab:sync');

variables

tasks

runonce

Runs a defined command on the target system once and only once.

# deploy.php
# ...

import('recipe/runonce.php');
# or
import('task/runonce.php');

# See `src/examples/runonce.yaml` for a yaml based example file.
import(__DIR__ . '/<path-to-configs>/runonce.yaml');

# When using the task instead of the recipe, add the run task to the deployment manually:
after('deploy:symlink', 'runonce:run');

variables

tasks

template

Copy files to the target system after replacing deployer placeholders.

# deploy.php
# ...

import('recipe/template.php');
# or
import('task/template.php');

# See `src/examples/template.yaml` for a yaml based example file.
import(__DIR__ . '/<path-to-configs>/template.yaml');

# When using the task instead of the recipe, add the sync task to the deployment manually:
after('deploy:symlink', 'template:sync');

variables

tasks

cleanup

Remove obsolete files and folders from older releases.

# deploy.php
# ...

import('recipe/cleanup.php');
# or
import('task/cleanup.php');

# When using the task instead of the recipe, add the run task to the deployment manually:
after('deploy', 'cleanup:paths');

variables

tasks

symlink

Creates symlinks anywhere on the host from a given list.

# deploy.php
# ...

import('recipe/symlink.php');
# or
import('task/symlink.php');

# When using the task instead of the recipe, add the run task to the deployment manually:
before('deploy:shared', 'symlink:create');

variables

tasks

supervisor

Stop and start task for supervisor to avoid runtime errors during deployment.

# deploy.php
# ...

import('recipe/supervisor.php');
# or
import('task/supervisor.php');

# When using the task instead of the recipe, add the run task to the deployment manually:
before('deploy:publish', 'supervisor:stop');
after('deploy:publish', 'supervisor:start');

variables

tasks