Recipes are simple PHP files that you can add in the include array of your config/deploy.php file, in order to provide additional tasks and options. Whilst Laravel Deployer provides its own set of tasks and options, it also includes official recipes from Deployer that you can make use of.
Deployer has an entire github repository full of useful recipes.
To use any of them, simply add 'recipe/<recipe_name>.php' to your includes and add the provided tasks to your hooks. Based on which recipe, you might also configure some options. Checkout the recipe's documentation provided by Deployer.org for more information.
// config/deploy.php
'include' => [
'recipe/<recipe_name>.php',
],
'hooks' => [
'start' => ['recipe_name:some:task'],
],
'options' => [
'some_option_from_recipe_name' => 'my value',
]| recipe name | description | |
|---|---|---|
bugsnag |
Enables you to send messages to Bugsnag. | doc |
cachetool |
Clears APC system cach and resets the contents of the opcode cache. | doc |
cloudflare |
Clears cloudflare cache. | doc |
hipchat |
Sends messages to hipchat. | doc |
newrelic |
Notifies New Relic of a new deployment. | doc |
npm |
(included). Install npm packages. Laravel Deployer already requires and extends this recipe to provide tasks that builds your assets. | doc |
phinx |
Migrate, rollback, run seeds and set a breakpoint for your database. | doc |
rabbit |
Sends messages to rabbit. | doc |
rollbar |
Send messages to rollbar. | doc |
rsync |
Performs rsync from local rsync_src dir to remote rsync_dest dir and performs a warmup rsync on remote. |
doc |
sentry |
Sends messages to Sentry. | doc |
slack |
Sends messages to slack including success and failure messages. | doc |
yammer |
Sends messages to yammer including success and failure messages. | doc |
yarn |
(included). Install Yarn packages. | doc |
raygun |
Send deployment details to Raygun. | doc |