mirror_php/deployer
1
0
Fork 0
mirror of https://github.com/deployphp/deployer.git synced 2025-01-18 05:58:15 +01:00
Code Issues Projects Releases Wiki Activity

Improve docgen

Browse Source
This commit is contained in:
Anton Medvedev 2021-08-31 20:15:06 +02:00
parent 983e0b31ec
commit 463d95de78
74 changed files with 1745 additions and 732 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/api.md
View File

@ -6,8 +6,8 @@
* [`host()`](#host)
* [`localhost()`](#localhost)
* [`getHost()`](#getHost)
* [`currentHost()`](#currentHost)
* [`getHost()`](#gethost)
* [`currentHost()`](#currenthost)
* [`select()`](#select)
* [`import()`](#import)
* [`desc()`](#desc)
@ -19,9 +19,9 @@
* [`cd()`](#cd)
* [`within()`](#within)
* [`run()`](#run)
* [`runLocally()`](#runLocally)
* [`runLocally()`](#runlocally)
* [`test()`](#test)
* [`testLocally()`](#testLocally)
* [`testLocally()`](#testlocally)
* [`on()`](#on)
* [`invoke()`](#invoke)
* [`upload()`](#upload)
@ -35,14 +35,14 @@
* [`get()`](#get)
* [`has()`](#has)
* [`ask()`](#ask)
* [`askChoice()`](#askChoice)
* [`askConfirmation()`](#askConfirmation)
* [`askHiddenResponse()`](#askHiddenResponse)
* [`askChoice()`](#askchoice)
* [`askConfirmation()`](#askconfirmation)
* [`askHiddenResponse()`](#askhiddenresponse)
* [`input()`](#input)
* [`output()`](#output)
* [`commandExist()`](#commandExist)
* [`commandSupportsOption()`](#commandSupportsOption)
* [`locateBinaryPath()`](#locateBinaryPath)
* [`commandExist()`](#commandexist)
* [`commandSupportsOption()`](#commandsupportsoption)
* [`locateBinaryPath()`](#locatebinarypath)
## host()

3
docs/contrib/bugsnag.md
View File

@ -29,7 +29,7 @@ after('deploy', 'bugsnag:notify');
* Tasks
* [`bugsnag:notify`](#bugsnagnotify) — Notifying Bugsnag of deployment
* [bugsnag:notify](#bugsnagnotify) — Notifying Bugsnag of deployment
## Tasks
@ -38,3 +38,4 @@ after('deploy', 'bugsnag:notify');

25
docs/contrib/cachetool.md
View File

@ -56,45 +56,54 @@ Read more information about cachetool on the website:
http://gordalina.github.io/cachetool/
* Config
* [`cachetool`](#cachetool)
* [`cachetool_args`](#cachetool_args)
* [`cachetool_options`](#cachetool_options)
* Configuration
* [cachetool](#cachetool)
* [cachetool_args](#cachetool_args)
* [cachetool_options](#cachetool_options)
* Tasks
* [`cachetool:clear:opcache`](#cachetoolclearopcache) — Clearing OPcode cache
* [`cachetool:clear:apcu`](#cachetoolclearapcu) — Clearing APCu system cache
* [`cachetool:clear:stat`](#cachetoolclearstat) — Clearing file status and realpath caches
* [cachetool:clear:opcache](#cachetoolclearopcache) — Clearing OPcode cache
* [cachetool:clear:apcu](#cachetoolclearapcu) — Clearing APCu system cache
* [cachetool:clear:stat](#cachetoolclearstat) — Clearing file status and realpath caches
## Config
## Configuration
### cachetool
[Source](https://github.com/deployphp/deployer/search?q=%22cachetool%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acachetool.php)
### cachetool_args
[Source](https://github.com/deployphp/deployer/search?q=%22cachetool_args%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acachetool.php)
### cachetool_options
[Source](https://github.com/deployphp/deployer/search?q=%22cachetool_options%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acachetool.php)
## Tasks
### cachetool:clear:opcache
[Source](https://github.com/deployphp/deployer/search?q=%22cachetool%3Aclear%3Aopcache%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acachetool.php)
Clear opcache cache
### cachetool:clear:apcu
[Source](https://github.com/deployphp/deployer/search?q=%22cachetool%3Aclear%3Aapcu%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acachetool.php)
Clear APCU cache
### cachetool:clear:stat
[Source](https://github.com/deployphp/deployer/search?q=%22cachetool%3Aclear%3Astat%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acachetool.php)
Clear file status cache, including the realpath cache

52
docs/contrib/chatwork.md
View File

@ -92,51 +92,72 @@ after('deploy:failed', 'chatwork:notify:failure');
```
* Config
* [`chatwork_token`](#chatwork_token)
* [`chatwork_room_id`](#chatwork_room_id)
* [`chatwork_api`](#chatwork_api)
* [`chatwork_notify_text`](#chatwork_notify_text)
* [`chatwork_success_text`](#chatwork_success_text)
* [`chatwork_failure_text`](#chatwork_failure_text)
* Configuration
* [chatwork_token](#chatwork_token)
* [chatwork_room_id](#chatwork_room_id)
* [chatwork_api](#chatwork_api)
* [chatwork_notify_text](#chatwork_notify_text)
* [chatwork_success_text](#chatwork_success_text)
* [chatwork_failure_text](#chatwork_failure_text)
* Tasks
* [`chatwork_send_message`](#chatwork_send_message)
* [`chatwork:test`](#chatworktest) — Just notify chatwork with all messages, without deploying
* [`chatwork:notify`](#chatworknotify) — Notifying Chatwork
* [`chatwork:notify:success`](#chatworknotifysuccess) — Notifying Chatwork about deploy finish
* [`chatwork:notify:failure`](#chatworknotifyfailure) — Notifying Chatwork about deploy failure
* [chatwork_send_message](#chatwork_send_message)
* [chatwork:test](#chatworktest) — Just notify chatwork with all messages, without deploying
* [chatwork:notify](#chatworknotify) — Notifying Chatwork
* [chatwork:notify:success](#chatworknotifysuccess) — Notifying Chatwork about deploy finish
* [chatwork:notify:failure](#chatworknotifyfailure) — Notifying Chatwork about deploy failure
## Config
## Configuration
### chatwork_token
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork_token%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
Chatwork settings
### chatwork_room_id
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork_room_id%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
### chatwork_api
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork_api%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
### chatwork_notify_text
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork_notify_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
The Messages
```php title="Default value"
"[info]\n[title](*) Deployment Status: Deploying[/title]\nRepo: {{repository}}\nBranch: {{branch}}\nServer: {{hostname}}\nRelease Path: {{release_path}}\nCurrent Path: {{current_path}}\n[/info]"
```
### chatwork_success_text
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork_success_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
```php title="Default value"
"[info]\n[title](*) Deployment Status: Successfully[/title]\nRepo: {{repository}}\nBranch: {{branch}}\nServer: {{hostname}}\nRelease Path: {{release_path}}\nCurrent Path: {{current_path}}\n[/info]"
```
### chatwork_failure_text
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork_failure_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
```php title="Default value"
"[info]\n[title](*) Deployment Status: Failed[/title]\nRepo: {{repository}}\nBranch: {{branch}}\nServer: {{hostname}}\nRelease Path: {{release_path}}\nCurrent Path: {{current_path}}\n[/info]"
```
## Tasks
### chatwork_send_message
@ -144,23 +165,28 @@ The Messages
Helpers
### chatwork:test
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork%3Atest%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
Tasks
### chatwork:notify
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork%3Anotify%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
### chatwork:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)
### chatwork:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22chatwork%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Achatwork.php)

91
docs/contrib/cimonitor.md
View File

@ -70,85 +70,139 @@ after('deploy:failed', 'cimonitor:notify:failure');
```
* Config
* [`cimonitor_title`](#cimonitor_title)
* [`cimonitor_user`](#cimonitor_user)
* [`cimonitor_status_info`](#cimonitor_status_info)
* [`cimonitor_status_warning`](#cimonitor_status_warning)
* [`cimonitor_status_error`](#cimonitor_status_error)
* [`cimonitor_status_success`](#cimonitor_status_success)
* [`cimonitor_job_state_info`](#cimonitor_job_state_info)
* [`cimonitor_job_state_pending`](#cimonitor_job_state_pending)
* [`cimonitor_job_state_running`](#cimonitor_job_state_running)
* [`cimonitor_job_state_warning`](#cimonitor_job_state_warning)
* [`cimonitor_job_state_error`](#cimonitor_job_state_error)
* [`cimonitor_job_state_success`](#cimonitor_job_state_success)
* Configuration
* [cimonitor_title](#cimonitor_title)
* [cimonitor_user](#cimonitor_user)
* [cimonitor_status_info](#cimonitor_status_info)
* [cimonitor_status_warning](#cimonitor_status_warning)
* [cimonitor_status_error](#cimonitor_status_error)
* [cimonitor_status_success](#cimonitor_status_success)
* [cimonitor_job_state_info](#cimonitor_job_state_info)
* [cimonitor_job_state_pending](#cimonitor_job_state_pending)
* [cimonitor_job_state_running](#cimonitor_job_state_running)
* [cimonitor_job_state_warning](#cimonitor_job_state_warning)
* [cimonitor_job_state_error](#cimonitor_job_state_error)
* [cimonitor_job_state_success](#cimonitor_job_state_success)
* Tasks
* [`cimonitor:notify`](#cimonitornotify) — Notifying CIMonitor
* [`cimonitor:notify:success`](#cimonitornotifysuccess) — Notifying CIMonitor about deploy finish
* [`cimonitor:notify:failure`](#cimonitornotifyfailure) — Notifying CIMonitor about deploy failure
* [cimonitor:notify](#cimonitornotify) — Notifying CIMonitor
* [cimonitor:notify:success](#cimonitornotifysuccess) — Notifying CIMonitor about deploy finish
* [cimonitor:notify:failure](#cimonitornotifyfailure) — Notifying CIMonitor about deploy failure
## Config
## Configuration
### cimonitor_title
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_title%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
Title of project based on git repo
### cimonitor_user
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_user%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
### cimonitor_status_info
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_status_info%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
CI monitor status states and job states
```php title="Default value"
'info'
```
### cimonitor_status_warning
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_status_warning%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
'warning'
```
### cimonitor_status_error
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_status_error%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
'error'
```
### cimonitor_status_success
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_status_success%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
'success'
```
### cimonitor_job_state_info
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_job_state_info%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
get('cimonitor_status_info')
```
### cimonitor_job_state_pending
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_job_state_pending%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
'pending'
```
### cimonitor_job_state_running
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_job_state_running%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
'running'
```
### cimonitor_job_state_warning
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_job_state_warning%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
get('cimonitor_status_warning')
```
### cimonitor_job_state_error
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_job_state_error%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
get('cimonitor_status_error')
```
### cimonitor_job_state_success
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor_job_state_success%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
```php title="Default value"
get('cimonitor_status_success')
```
## Tasks
### cimonitor:notify
@ -156,13 +210,16 @@ CI monitor status states and job states
### cimonitor:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)
### cimonitor:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22cimonitor%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acimonitor.php)

3
docs/contrib/cloudflare.md
View File

@ -31,7 +31,7 @@ if not the, last tasks before cleanup
* Tasks
* [`deploy:cloudflare`](#deploycloudflare) — Clearing Cloudflare Cache
* [deploy:cloudflare](#deploycloudflare) — Clearing Cloudflare Cache
## Tasks
@ -40,3 +40,4 @@ if not the, last tasks before cleanup

9
docs/contrib/cpanel.md
View File

@ -150,9 +150,9 @@ after('deploy:prepare', 'cpanel:createdb');
* Tasks
* [`cpanel:createdb`](#cpanelcreatedb) — Creating database though CPanel API
* [`cpanel:createaddondomain`](#cpanelcreateaddondomain) — Creating addon domain though CPanel API
* [`cpanel:deleteaddondomain`](#cpaneldeleteaddondomain) — Delete addon domain though CPanel API
* [cpanel:createdb](#cpanelcreatedb) — Creating database though CPanel API
* [cpanel:createaddondomain](#cpanelcreateaddondomain) — Creating addon domain though CPanel API
* [cpanel:deleteaddondomain](#cpaneldeleteaddondomain) — Delete addon domain though CPanel API
## Tasks
@ -161,13 +161,16 @@ after('deploy:prepare', 'cpanel:createdb');
### cpanel:createaddondomain
[Source](https://github.com/deployphp/deployer/search?q=%22cpanel%3Acreateaddondomain%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acpanel.php)
### cpanel:deleteaddondomain
[Source](https://github.com/deployphp/deployer/search?q=%22cpanel%3Adeleteaddondomain%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acpanel.php)

6
docs/contrib/crontab.md
View File

@ -29,8 +29,8 @@ add('crontab:jobs', [
* Tasks
* [`crontab:load`](#crontabload) — Load crontab
* [`crontab:sync`](#crontabsync) — Sync crontab jobs
* [crontab:load](#crontabload) — Load crontab
* [crontab:sync](#crontabsync) — Sync crontab jobs
## Tasks
@ -39,8 +39,10 @@ add('crontab:jobs', [
### crontab:sync
[Source](https://github.com/deployphp/deployer/search?q=%22crontab%3Async%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Acrontab.php)

18
docs/contrib/directadmin.md
View File

@ -98,12 +98,12 @@ task('deploy', [
* Tasks
* [`directadmin:createdb`](#directadmincreatedb) — Create a database on DirectAdmin
* [`directadmin:deletedb`](#directadmindeletedb) — Delete a database on DirectAdmin
* [`directadmin:createdomain`](#directadmincreatedomain) — Create a domain on DirectAdmin
* [`directadmin:deletedomain`](#directadmindeletedomain) — Delete a domain on DirectAdmin
* [`directadmin:symlink-private-html`](#directadminsymlink-private-html) — Symlink your private_html to public_html
* [`directadmin:php-version`](#directadminphp-version) — Change the PHP version from a domain
* [directadmin:createdb](#directadmincreatedb) — Create a database on DirectAdmin
* [directadmin:deletedb](#directadmindeletedb) — Delete a database on DirectAdmin
* [directadmin:createdomain](#directadmincreatedomain) — Create a domain on DirectAdmin
* [directadmin:deletedomain](#directadmindeletedomain) — Delete a domain on DirectAdmin
* [directadmin:symlink-private-html](#directadminsymlink-private-html) — Symlink your private_html to public_html
* [directadmin:php-version](#directadminphp-version) — Change the PHP version from a domain
## Tasks
@ -112,28 +112,34 @@ task('deploy', [
### directadmin:deletedb
[Source](https://github.com/deployphp/deployer/search?q=%22directadmin%3Adeletedb%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adirectadmin.php)
### directadmin:createdomain
[Source](https://github.com/deployphp/deployer/search?q=%22directadmin%3Acreatedomain%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adirectadmin.php)
### directadmin:deletedomain
[Source](https://github.com/deployphp/deployer/search?q=%22directadmin%3Adeletedomain%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adirectadmin.php)
### directadmin:symlink-private-html
[Source](https://github.com/deployphp/deployer/search?q=%22directadmin%3Asymlink-private-html%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adirectadmin.php)
### directadmin:php-version
[Source](https://github.com/deployphp/deployer/search?q=%22directadmin%3Aphp-version%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adirectadmin.php)

48
docs/contrib/discord.md
View File

@ -28,15 +28,15 @@ before('deploy', 'discord:notify');
- `discord_notify_text` – notification message template, markdown supported, default:
```markdown
:information_source: **{{user}}** is deploying branch `{{branch}}` to _{{target}}_
:​information_source: **{{user}}** is deploying branch `{{branch}}` to _{{target}}_
```
- `discord_success_text` – success template, default:
```markdown
:white_check_mark: Branch `{{branch}}` deployed to _{{target}}_ successfully
:​white_check_mark: Branch `{{branch}}` deployed to _{{target}}_ successfully
```
- `discord_failure_text` – failure template, default:
```markdown
:no_entry_sign: Branch `{{branch}}` has failed to deploy to _{{target}}_
:​no_entry_sign: Branch `{{branch}}` has failed to deploy to _{{target}}_
## Usage
@ -59,45 +59,58 @@ after('deploy:failed', 'discord:notify:failure');
```
* Config
* [`discord_webhook`](#discord_webhook)
* [`discord_notify_text`](#discord_notify_text)
* [`discord_success_text`](#discord_success_text)
* [`discord_failure_text`](#discord_failure_text)
* [`discord_message`](#discord_message)
* Configuration
* [discord_webhook](#discord_webhook)
* [discord_notify_text](#discord_notify_text)
* [discord_success_text](#discord_success_text)
* [discord_failure_text](#discord_failure_text)
* [discord_message](#discord_message)
* Tasks
* [`discord_send_message`](#discord_send_message)
* [`discord:test`](#discordtest) — Just notify your Discord channel with all messages, without deploying
* [`discord:notify`](#discordnotify) — Notify Discord
* [`discord:notify:success`](#discordnotifysuccess) — Notify Discord about deploy finish
* [`discord:notify:failure`](#discordnotifyfailure) — Notify Discord about deploy failure
* [discord_send_message](#discord_send_message)
* [discord:test](#discordtest) — Just notify your Discord channel with all messages, without deploying
* [discord:notify](#discordnotify) — Notify Discord
* [discord:notify:success](#discordnotifysuccess) — Notify Discord about deploy finish
* [discord:notify:failure](#discordnotifyfailure) — Notify Discord about deploy failure
## Config
## Configuration
### discord_webhook
[Source](https://github.com/deployphp/deployer/search?q=%22discord_webhook%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)
### discord_notify_text
[Source](https://github.com/deployphp/deployer/search?q=%22discord_notify_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)
Deploy messages
### discord_success_text
[Source](https://github.com/deployphp/deployer/search?q=%22discord_success_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)
### discord_failure_text
[Source](https://github.com/deployphp/deployer/search?q=%22discord_failure_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)
### discord_message
[Source](https://github.com/deployphp/deployer/search?q=%22discord_message%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)
The message
```php title="Default value"
'discord_notify_text'
```
## Tasks
### discord_send_message
@ -105,23 +118,28 @@ The message
Helpers
### discord:test
[Source](https://github.com/deployphp/deployer/search?q=%22discord%3Atest%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)
Tasks
### discord:notify
[Source](https://github.com/deployphp/deployer/search?q=%22discord%3Anotify%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)
### discord:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22discord%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)
### discord:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22discord%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Adiscord.php)

3
docs/contrib/grafana.md
View File

@ -45,7 +45,7 @@ after('deploy:success', 'grafana:annotation');
* Tasks
* [`grafana:annotation`](#grafanaannotation) — Create Grafana annotation of deployment
* [grafana:annotation](#grafanaannotation) — Create Grafana annotation of deployment
## Tasks
@ -54,3 +54,4 @@ after('deploy:success', 'grafana:annotation');

45
docs/contrib/hangouts.md
View File

@ -50,43 +50,65 @@ after('deploy:failed', 'chat:notify:failure');
* Config
* [`chat_title`](#chat_title)
* [`chat_subtitle`](#chat_subtitle)
* [`favicon`](#favicon)
* [`chat_line1`](#chat_line1)
* [`chat_line2`](#chat_line2)
* Configuration
* [chat_title](#chat_title)
* [chat_subtitle](#chat_subtitle)
* [favicon](#favicon)
* [chat_line1](#chat_line1)
* [chat_line2](#chat_line2)
* Tasks
* [`chat:notify`](#chatnotify) — Notifying Google Hangouts Chat
* [`chat:notify:success`](#chatnotifysuccess) — Notifying Google Hangouts Chat about deploy finish
* [`chat:notify:failure`](#chatnotifyfailure)
* [chat:notify](#chatnotify) — Notifying Google Hangouts Chat
* [chat:notify:success](#chatnotifysuccess) — Notifying Google Hangouts Chat about deploy finish
* [chat:notify:failure](#chatnotifyfailure)
## Config
## Configuration
### chat_title
[Source](https://github.com/deployphp/deployer/search?q=%22chat_title%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahangouts.php)
Title of project
### chat_subtitle
[Source](https://github.com/deployphp/deployer/search?q=%22chat_subtitle%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahangouts.php)
```php title="Default value"
get('hostname')
```
### favicon
[Source](https://github.com/deployphp/deployer/search?q=%22favicon%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahangouts.php)
If 'favicon' is set Google Hangouts Chat will decorate your card with an image.
```php title="Default value"
'http://{{hostname}}/favicon.png'
```
### chat_line1
[Source](https://github.com/deployphp/deployer/search?q=%22chat_line1%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahangouts.php)
Deploy messages
```php title="Default value"
'{{branch}}'
```
### chat_line2
[Source](https://github.com/deployphp/deployer/search?q=%22chat_line2%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahangouts.php)
```php title="Default value"
'{{stage}}'
```
## Tasks
### chat:notify
@ -94,13 +116,16 @@ Deploy messages
### chat:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22chat%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahangouts.php)
### chat:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22chat%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahangouts.php)

35
docs/contrib/hipchat.md
View File

@ -34,35 +34,55 @@ after('deploy', 'hipchat:notify');
* Config
* [`hipchat_color`](#hipchat_color)
* [`hipchat_from`](#hipchat_from)
* [`hipchat_message`](#hipchat_message)
* [`hipchat_url`](#hipchat_url)
* Configuration
* [hipchat_color](#hipchat_color)
* [hipchat_from](#hipchat_from)
* [hipchat_message](#hipchat_message)
* [hipchat_url](#hipchat_url)
* Tasks
* [`hipchat:notify`](#hipchatnotify) — Notifying Hipchat channel of deployment
* [hipchat:notify](#hipchatnotify) — Notifying Hipchat channel of deployment
## Config
## Configuration
### hipchat_color
[Source](https://github.com/deployphp/deployer/search?q=%22hipchat_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahipchat.php)
```php title="Default value"
'green'
```
### hipchat_from
[Source](https://github.com/deployphp/deployer/search?q=%22hipchat_from%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahipchat.php)
```php title="Default value"
'{{target}}'
```
### hipchat_message
[Source](https://github.com/deployphp/deployer/search?q=%22hipchat_message%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahipchat.php)
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
```
### hipchat_url
[Source](https://github.com/deployphp/deployer/search?q=%22hipchat_url%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ahipchat.php)
```php title="Default value"
'https://api.hipchat.com/v1/rooms/message'
```
## Tasks
### hipchat:notify
@ -70,3 +90,4 @@ after('deploy', 'hipchat:notify');

88
docs/contrib/ispmanager.md
View File

@ -10,147 +10,185 @@
This recipe for work with ISPManager Lite panel by API.
* Config
* [`ispmanager_owner`](#ispmanager_owner)
* [`ispmanager_doc_root`](#ispmanager_doc_root)
* [`ispmanager`](#ispmanager)
* [`vhost`](#vhost)
* [`ispmanager_session`](#ispmanager_session)
* [`ispmanager_databases`](#ispmanager_databases)
* [`ispmanager_domains`](#ispmanager_domains)
* [`ispmanager_phplist`](#ispmanager_phplist)
* [`ispmanager_aliaslist`](#ispmanager_aliaslist)
* Configuration
* [ispmanager_owner](#ispmanager_owner)
* [ispmanager_doc_root](#ispmanager_doc_root)
* [ispmanager](#ispmanager)
* [vhost](#vhost)
* [ispmanager_session](#ispmanager_session)
* [ispmanager_databases](#ispmanager_databases)
* [ispmanager_domains](#ispmanager_domains)
* [ispmanager_phplist](#ispmanager_phplist)
* [ispmanager_aliaslist](#ispmanager_aliaslist)
* Tasks
* [`ispmanager:init`](#ispmanagerinit) — Initialisation
* [`ispmanager:db-server-list`](#ispmanagerdb-server-list) — Take database servers list
* [`ispmanager:db-list`](#ispmanagerdb-list) — Take databases list
* [`ispmanager:domain-list`](#ispmanagerdomain-list) — Take domain list
* [`ispmanager:db-create`](#ispmanagerdb-create) — Create new database
* [`ispmanager:db-delete`](#ispmanagerdb-delete) — Delete database
* [`ispmanager:domain-create`](#ispmanagerdomain-create) — Create new domain
* [`ispmanager:get-php-list`](#ispmanagerget-php-list) — Get allowed PHP modes and versions
* [`ispmanager:print-php-list`](#ispmanagerprint-php-list) — Print allowed PHP modes and versions
* [`ispmanager:domain-php-select`](#ispmanagerdomain-php-select) — Switch PHP version for domain
* [`ispmanager:domain-alias-create`](#ispmanagerdomain-alias-create) — Create new domain alias
* [`ispmanager:domain-alias-delete`](#ispmanagerdomain-alias-delete) — Delete domain alias
* [`ispmanager:domain-delete`](#ispmanagerdomain-delete) — Delete domain
* [`ispmanager:process`](#ispmanagerprocess) — Auto task processing
* [ispmanager:init](#ispmanagerinit) — Initialisation
* [ispmanager:db-server-list](#ispmanagerdb-server-list) — Take database servers list
* [ispmanager:db-list](#ispmanagerdb-list) — Take databases list
* [ispmanager:domain-list](#ispmanagerdomain-list) — Take domain list
* [ispmanager:db-create](#ispmanagerdb-create) — Create new database
* [ispmanager:db-delete](#ispmanagerdb-delete) — Delete database
* [ispmanager:domain-create](#ispmanagerdomain-create) — Create new domain
* [ispmanager:get-php-list](#ispmanagerget-php-list) — Get allowed PHP modes and versions
* [ispmanager:print-php-list](#ispmanagerprint-php-list) — Print allowed PHP modes and versions
* [ispmanager:domain-php-select](#ispmanagerdomain-php-select) — Switch PHP version for domain
* [ispmanager:domain-alias-create](#ispmanagerdomain-alias-create) — Create new domain alias
* [ispmanager:domain-alias-delete](#ispmanagerdomain-alias-delete) — Delete domain alias
* [ispmanager:domain-delete](#ispmanagerdomain-delete) — Delete domain
* [ispmanager:process](#ispmanagerprocess) — Auto task processing
## Config
## Configuration
### ispmanager_owner
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager_owner%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
```php title="Default value"
'www-root'
```
### ispmanager_doc_root
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager_doc_root%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
```php title="Default value"
'/var/www/' . get('ispmanager_owner') . '/data/'
```
### ispmanager
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
ISPManager default configuration
### vhost
[Source](https://github.com/deployphp/deployer/search?q=%22vhost%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
Vhost default configuration
### ispmanager_session
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager_session%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
Storage
### ispmanager_databases
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager_databases%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager_domains
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager_domains%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager_phplist
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager_phplist%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager_aliaslist
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager_aliaslist%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
## Tasks
### ispmanager:init
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Ainit%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:db-server-list
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adb-server-list%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:db-list
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adb-list%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:domain-list
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adomain-list%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:db-create
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adb-create%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:db-delete
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adb-delete%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:domain-create
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adomain-create%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:get-php-list
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Aget-php-list%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:print-php-list
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Aprint-php-list%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:domain-php-select
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adomain-php-select%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:domain-alias-create
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adomain-alias-create%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:domain-alias-delete
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adomain-alias-delete%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:domain-delete
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Adomain-delete%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)
### ispmanager:process
[Source](https://github.com/deployphp/deployer/search?q=%22ispmanager%3Aprocess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aispmanager.php)

76
docs/contrib/mattermost.md
View File

@ -87,67 +87,112 @@ after('deploy:failed', 'mattermost:notify:failure');
* Config
* [`mattermost_webhook`](#mattermost_webhook)
* [`mattermost_channel`](#mattermost_channel)
* [`mattermost_username`](#mattermost_username)
* [`mattermost_icon_url`](#mattermost_icon_url)
* [`mattermost_success_emoji`](#mattermost_success_emoji)
* [`mattermost_failure_emoji`](#mattermost_failure_emoji)
* [`mattermost_text`](#mattermost_text)
* [`mattermost_success_text`](#mattermost_success_text)
* [`mattermost_failure_text`](#mattermost_failure_text)
* Configuration
* [mattermost_webhook](#mattermost_webhook)
* [mattermost_channel](#mattermost_channel)
* [mattermost_username](#mattermost_username)
* [mattermost_icon_url](#mattermost_icon_url)
* [mattermost_success_emoji](#mattermost_success_emoji)
* [mattermost_failure_emoji](#mattermost_failure_emoji)
* [mattermost_text](#mattermost_text)
* [mattermost_success_text](#mattermost_success_text)
* [mattermost_failure_text](#mattermost_failure_text)
* Tasks
* [`mattermost:notify`](#mattermostnotify) — Notify mattermost
* [`mattermost:notify:success`](#mattermostnotifysuccess) — Notifying mattermost about deploy finish
* [`mattermost:notify:failure`](#mattermostnotifyfailure) — Notifying mattermost about deploy failure
* [mattermost:notify](#mattermostnotify) — Notify mattermost
* [mattermost:notify:success](#mattermostnotifysuccess) — Notifying mattermost about deploy finish
* [mattermost:notify:failure](#mattermostnotifyfailure) — Notifying mattermost about deploy failure
## Config
## Configuration
### mattermost_webhook
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_webhook%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
null
```
### mattermost_channel
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_channel%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
null
```
### mattermost_username
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_username%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
'deployer'
```
### mattermost_icon_url
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_icon_url%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
null
```
### mattermost_success_emoji
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_success_emoji%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
':​white_check_mark:'
```
### mattermost_failure_emoji
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_failure_emoji%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
':​x:'
```
### mattermost_text
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to **{{target}}**'
```
### mattermost_success_text
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_success_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
'Deploy to **{{target}}** successful {{mattermost_success_emoji}}'
```
### mattermost_failure_text
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost_failure_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
```php title="Default value"
'Deploy to **{{target}}** failed {{mattermost_failure_emoji}}'
```
## Tasks
### mattermost:notify
@ -155,13 +200,16 @@ after('deploy:failed', 'mattermost:notify:failure');
### mattermost:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)
### mattermost:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22mattermost%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Amattermost.php)

59
docs/contrib/ms-teams.md
View File

@ -78,55 +78,87 @@ after('deploy:failed', 'teams:notify:failure');
```
* Config
* [`teams_title`](#teams_title)
* [`teams_text`](#teams_text)
* [`teams_success_text`](#teams_success_text)
* [`teams_failure_text`](#teams_failure_text)
* [`teams_color`](#teams_color)
* [`teams_success_color`](#teams_success_color)
* [`teams_failure_color`](#teams_failure_color)
* Configuration
* [teams_title](#teams_title)
* [teams_text](#teams_text)
* [teams_success_text](#teams_success_text)
* [teams_failure_text](#teams_failure_text)
* [teams_color](#teams_color)
* [teams_success_color](#teams_success_color)
* [teams_failure_color](#teams_failure_color)
* Tasks
* [`teams:notify`](#teamsnotify) — Notifying Teams
* [`teams:notify:success`](#teamsnotifysuccess) — Notifying Teams about deploy finish
* [`teams:notify:failure`](#teamsnotifyfailure) — Notifying Teams about deploy failure
* [teams:notify](#teamsnotify) — Notifying Teams
* [teams:notify:success](#teamsnotifysuccess) — Notifying Teams about deploy finish
* [teams:notify:failure](#teamsnotifyfailure) — Notifying Teams about deploy failure
## Config
## Configuration
### teams_title
[Source](https://github.com/deployphp/deployer/search?q=%22teams_title%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)
Title of project
### teams_text
[Source](https://github.com/deployphp/deployer/search?q=%22teams_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)
Deploy message
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
```
### teams_success_text
[Source](https://github.com/deployphp/deployer/search?q=%22teams_success_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)
```php title="Default value"
'Deploy to *{{target}}* successful'
```
### teams_failure_text
[Source](https://github.com/deployphp/deployer/search?q=%22teams_failure_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)
```php title="Default value"
'Deploy to *{{target}}* failed'
```
### teams_color
[Source](https://github.com/deployphp/deployer/search?q=%22teams_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)
Color of attachment
```php title="Default value"
'#4d91f7'
```
### teams_success_color
[Source](https://github.com/deployphp/deployer/search?q=%22teams_success_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)
```php title="Default value"
'#00c100'
```
### teams_failure_color
[Source](https://github.com/deployphp/deployer/search?q=%22teams_failure_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)
```php title="Default value"
'#ff0909'
```
## Tasks
### teams:notify
@ -134,13 +166,16 @@ Color of attachment
### teams:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22teams%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)
### teams:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22teams%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ams-teams.php)

19
docs/contrib/newrelic.md
View File

@ -31,33 +31,40 @@ after('deploy', 'newrelic:notify');
* Config
* [`newrelic_app_id`](#newrelic_app_id)
* [`newrelic_description`](#newrelic_description)
* [`newrelic_revision`](#newrelic_revision)
* Configuration
* [newrelic_app_id](#newrelic_app_id)
* [newrelic_description](#newrelic_description)
* [newrelic_revision](#newrelic_revision)
* Tasks
* [`newrelic:notify`](#newrelicnotify) — Notifying New Relic of deployment
* [newrelic:notify](#newrelicnotify) — Notifying New Relic of deployment
## Config
## Configuration
### newrelic_app_id
[Source](https://github.com/deployphp/deployer/search?q=%22newrelic_app_id%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Anewrelic.php)
### newrelic_description
[Source](https://github.com/deployphp/deployer/search?q=%22newrelic_description%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Anewrelic.php)
### newrelic_revision
[Source](https://github.com/deployphp/deployer/search?q=%22newrelic_revision%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Anewrelic.php)
## Tasks
### newrelic:notify
[Source](https://github.com/deployphp/deployer/search?q=%22newrelic%3Anotify%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Anewrelic.php)

3
docs/contrib/npm.md
View File

@ -28,7 +28,7 @@ after('deploy:update_code', 'npm:install');
* Tasks
* [`npm:install`](#npminstall) — Install npm packages
* [npm:install](#npminstall) — Install npm packages
## Tasks
@ -37,3 +37,4 @@ after('deploy:update_code', 'npm:install');
In there is a {{previous_release}}, node_modules will be copied from it before installing deps.

12
docs/contrib/phinx.md
View File

@ -72,10 +72,10 @@ For further reading see [phinx.org](https://phinx.org). Complete descriptions of
* Tasks
* [`phinx:migrate`](#phinxmigrate) — Migrating database with phinx
* [`phinx:rollback`](#phinxrollback) — Rollback database migrations with phinx
* [`phinx:seed`](#phinxseed) — Seed database with phinx
* [`phinx:breakpoint`](#phinxbreakpoint) — Set a migrations breakpoint with phinx
* [phinx:migrate](#phinxmigrate) — Migrating database with phinx
* [phinx:rollback](#phinxrollback) — Rollback database migrations with phinx
* [phinx:seed](#phinxseed) — Seed database with phinx
* [phinx:breakpoint](#phinxbreakpoint) — Set a migrations breakpoint with phinx
## Tasks
@ -84,18 +84,22 @@ For further reading see [phinx.org](https://phinx.org). Complete descriptions of
### phinx:rollback
[Source](https://github.com/deployphp/deployer/search?q=%22phinx%3Arollback%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aphinx.php)
### phinx:seed
[Source](https://github.com/deployphp/deployer/search?q=%22phinx%3Aseed%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aphinx.php)
### phinx:breakpoint
[Source](https://github.com/deployphp/deployer/search?q=%22phinx%3Abreakpoint%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aphinx.php)

25
docs/contrib/php-fpm.md
View File

@ -35,29 +35,41 @@ after('deploy', 'php-fpm:reload');
* Config
* [`php_fpm_version`](#php_fpm_version)
* [`php_fpm_service`](#php_fpm_service)
* [`php_fpm_command`](#php_fpm_command)
* Configuration
* [php_fpm_version](#php_fpm_version)
* [php_fpm_service](#php_fpm_service)
* [php_fpm_command](#php_fpm_command)
* Tasks
* [`php-fpm:reload`](#php-fpmreload) — Reload the php-fpm service
* [php-fpm:reload](#php-fpmreload) — Reload the php-fpm service
## Config
## Configuration
### php_fpm_version
[Source](https://github.com/deployphp/deployer/search?q=%22php_fpm_version%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aphp-fpm.php)
### php_fpm_service
[Source](https://github.com/deployphp/deployer/search?q=%22php_fpm_service%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aphp-fpm.php)
```php title="Default value"
'php{{php_fpm_version}}-fpm'
```
### php_fpm_command
[Source](https://github.com/deployphp/deployer/search?q=%22php_fpm_command%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aphp-fpm.php)
```php title="Default value"
'echo "" | sudo -S /usr/sbin/service {{php_fpm_service}} reload'
```
## Tasks
### php-fpm:reload
@ -65,3 +77,4 @@ after('deploy', 'php-fpm:reload');

3
docs/contrib/rabbit.md
View File

@ -56,7 +56,7 @@ before('deploy:end', 'deploy:rabbit');
* Tasks
* [`deploy:rabbit`](#deployrabbit) — Notifying RabbitMQ channel about deployment
* [deploy:rabbit](#deployrabbit) — Notifying RabbitMQ channel about deployment
## Tasks
@ -65,3 +65,4 @@ before('deploy:end', 'deploy:rabbit');

3
docs/contrib/raygun.md
View File

@ -35,7 +35,7 @@ after('deploy', 'raygun:notify');
* Tasks
* [`raygun:notify`](#raygunnotify) — Notifying Raygun of deployment
* [raygun:notify](#raygunnotify) — Notifying Raygun of deployment
## Tasks
@ -44,3 +44,4 @@ after('deploy', 'raygun:notify');

101
docs/contrib/rocketchat.md
View File

@ -71,91 +71,153 @@ after('deploy:failed', 'rocketchat:notify:failure');
* Config
* [`rockchat_title`](#rockchat_title)
* [`rocketchat_icon_emoji`](#rocketchat_icon_emoji)
* [`rocketchat_icon_url`](#rocketchat_icon_url)
* [`rocketchat_channel`](#rocketchat_channel)
* [`rocketchat_room_id`](#rocketchat_room_id)
* [`rocketchat_username`](#rocketchat_username)
* [`rocketchat_webhook`](#rocketchat_webhook)
* [`rocketchat_color`](#rocketchat_color)
* [`rocketchat_success_color`](#rocketchat_success_color)
* [`rocketchat_failure_color`](#rocketchat_failure_color)
* [`rocketchat_text`](#rocketchat_text)
* [`rocketchat_success_text`](#rocketchat_success_text)
* [`rocketchat_failure_text`](#rocketchat_failure_text)
* Configuration
* [rockchat_title](#rockchat_title)
* [rocketchat_icon_emoji](#rocketchat_icon_emoji)
* [rocketchat_icon_url](#rocketchat_icon_url)
* [rocketchat_channel](#rocketchat_channel)
* [rocketchat_room_id](#rocketchat_room_id)
* [rocketchat_username](#rocketchat_username)
* [rocketchat_webhook](#rocketchat_webhook)
* [rocketchat_color](#rocketchat_color)
* [rocketchat_success_color](#rocketchat_success_color)
* [rocketchat_failure_color](#rocketchat_failure_color)
* [rocketchat_text](#rocketchat_text)
* [rocketchat_success_text](#rocketchat_success_text)
* [rocketchat_failure_text](#rocketchat_failure_text)
* Tasks
* [`rocketchat:notify`](#rocketchatnotify) — Notify RocketChat
* [`rocketchat:notify:success`](#rocketchatnotifysuccess) — Notifying RocketChat about deploy finish
* [`rocketchat:notify:failure`](#rocketchatnotifyfailure) — Notifying RocketChat about deploy failure
* [rocketchat:notify](#rocketchatnotify) — Notify RocketChat
* [rocketchat:notify:success](#rocketchatnotifysuccess) — Notifying RocketChat about deploy finish
* [rocketchat:notify:failure](#rocketchatnotifyfailure) — Notifying RocketChat about deploy failure
## Config
## Configuration
### rockchat_title
[Source](https://github.com/deployphp/deployer/search?q=%22rockchat_title%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
### rocketchat_icon_emoji
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_icon_emoji%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
':robot:'
```
### rocketchat_icon_url
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_icon_url%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
null
```
### rocketchat_channel
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_channel%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
null
```
### rocketchat_room_id
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_room_id%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
null
```
### rocketchat_username
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_username%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
null
```
### rocketchat_webhook
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_webhook%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
null
```
### rocketchat_color
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
'#000000'
```
### rocketchat_success_color
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_success_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
'#00c100'
```
### rocketchat_failure_color
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_failure_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
'#ff0909'
```
### rocketchat_text
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
```
### rocketchat_success_text
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_success_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
'Deploy to *{{target}}* successful'
```
### rocketchat_failure_text
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat_failure_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
```php title="Default value"
'Deploy to *{{target}}* failed'
```
## Tasks
### rocketchat:notify
@ -163,13 +225,16 @@ after('deploy:failed', 'rocketchat:notify:failure');
### rocketchat:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)
### rocketchat:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22rocketchat%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arocketchat.php)

14
docs/contrib/rollbar.md
View File

@ -34,17 +34,22 @@ after('deploy', 'rollbar:notify');
* Config
* [`rollbar_comment`](#rollbar_comment)
* Configuration
* [rollbar_comment](#rollbar_comment)
* Tasks
* [`rollbar:notify`](#rollbarnotify) — Notifying Rollbar of deployment
* [rollbar:notify](#rollbarnotify) — Notifying Rollbar of deployment
## Config
## Configuration
### rollbar_comment
[Source](https://github.com/deployphp/deployer/search?q=%22rollbar_comment%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arollbar.php)
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
```
## Tasks
### rollbar:notify
@ -52,3 +57,4 @@ after('deploy', 'rollbar:notify');

44
docs/contrib/rsync.md
View File

@ -123,63 +123,85 @@ host('hostname')
* Config
* [`rsync`](#rsync)
* [`rsync_src`](#rsync_src)
* [`rsync_dest`](#rsync_dest)
* [`rsync_excludes`](#rsync_excludes)
* [`rsync_includes`](#rsync_includes)
* [`rsync_filter`](#rsync_filter)
* [`rsync_options`](#rsync_options)
* Configuration
* [rsync](#rsync)
* [rsync_src](#rsync_src)
* [rsync_dest](#rsync_dest)
* [rsync_excludes](#rsync_excludes)
* [rsync_includes](#rsync_includes)
* [rsync_filter](#rsync_filter)
* [rsync_options](#rsync_options)
* Tasks
* [`rsync:warmup`](#rsyncwarmup) — Warmup remote Rsync target
* [`rsync`](#rsync) — Rsync local->remote
* [rsync:warmup](#rsyncwarmup) — Warmup remote Rsync target
* [rsync](#rsync) — Rsync local->remote
## Config
## Configuration
### rsync
[Source](https://github.com/deployphp/deployer/search?q=%22rsync%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)
### rsync_src
[Source](https://github.com/deployphp/deployer/search?q=%22rsync_src%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)
```php title="Default value"
__DIR__
```
### rsync_dest
[Source](https://github.com/deployphp/deployer/search?q=%22rsync_dest%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)
```php title="Default value"
'{{release_path}}'
```
### rsync_excludes
[Source](https://github.com/deployphp/deployer/search?q=%22rsync_excludes%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)
### rsync_includes
[Source](https://github.com/deployphp/deployer/search?q=%22rsync_includes%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)
### rsync_filter
[Source](https://github.com/deployphp/deployer/search?q=%22rsync_filter%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)
### rsync_options
[Source](https://github.com/deployphp/deployer/search?q=%22rsync_options%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)
## Tasks
### rsync:warmup
[Source](https://github.com/deployphp/deployer/search?q=%22rsync%3Awarmup%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)
### rsync
[Source](https://github.com/deployphp/deployer/search?q=%22rsync%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Arsync.php)

83
docs/contrib/slack.md
View File

@ -70,74 +70,121 @@ after('deploy:failed', 'slack:notify:failure');
* Config
* [`slack_channel`](#slack_channel)
* [`slack_title`](#slack_title)
* [`slack_text`](#slack_text)
* [`slack_success_text`](#slack_success_text)
* [`slack_failure_text`](#slack_failure_text)
* [`slack_rollback_text`](#slack_rollback_text)
* [`slack_color`](#slack_color)
* [`slack_success_color`](#slack_success_color)
* [`slack_failure_color`](#slack_failure_color)
* [`slack_rollback_color`](#slack_rollback_color)
* Configuration
* [slack_channel](#slack_channel)
* [slack_title](#slack_title)
* [slack_text](#slack_text)
* [slack_success_text](#slack_success_text)
* [slack_failure_text](#slack_failure_text)
* [slack_rollback_text](#slack_rollback_text)
* [slack_color](#slack_color)
* [slack_success_color](#slack_success_color)
* [slack_failure_color](#slack_failure_color)
* [slack_rollback_color](#slack_rollback_color)
* Tasks
* [`slack:notify`](#slacknotify) — Notifying Slack
* [`slack:notify:success`](#slacknotifysuccess) — Notifying Slack about deploy finish
* [`slack:notify:failure`](#slacknotifyfailure) — Notifying Slack about deploy failure
* [`slack:notify:rollback`](#slacknotifyrollback) — Notifying Slack about rollback
* [slack:notify](#slacknotify) — Notifying Slack
* [slack:notify:success](#slacknotifysuccess) — Notifying Slack about deploy finish
* [slack:notify:failure](#slacknotifyfailure) — Notifying Slack about deploy failure
* [slack:notify:rollback](#slacknotifyrollback) — Notifying Slack about rollback
## Config
## Configuration
### slack_channel
[Source](https://github.com/deployphp/deployer/search?q=%22slack_channel%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
Channel to publish to, when false the default channel the webhook will be used
```php title="Default value"
false
```
### slack_title
[Source](https://github.com/deployphp/deployer/search?q=%22slack_title%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
Title of project
### slack_text
[Source](https://github.com/deployphp/deployer/search?q=%22slack_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
Deploy message
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
```
### slack_success_text
[Source](https://github.com/deployphp/deployer/search?q=%22slack_success_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
```php title="Default value"
'Deploy to *{{target}}* successful'
```
### slack_failure_text
[Source](https://github.com/deployphp/deployer/search?q=%22slack_failure_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
```php title="Default value"
'Deploy to *{{target}}* failed'
```
### slack_rollback_text
[Source](https://github.com/deployphp/deployer/search?q=%22slack_rollback_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
```php title="Default value"
'_{{user}}_ rolled back changes on *{{target}}*'
```
### slack_color
[Source](https://github.com/deployphp/deployer/search?q=%22slack_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
Color of attachment
```php title="Default value"
'#4d91f7'
```
### slack_success_color
[Source](https://github.com/deployphp/deployer/search?q=%22slack_success_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
```php title="Default value"
'#00c100'
```
### slack_failure_color
[Source](https://github.com/deployphp/deployer/search?q=%22slack_failure_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
```php title="Default value"
'#ff0909'
```
### slack_rollback_color
[Source](https://github.com/deployphp/deployer/search?q=%22slack_rollback_color%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
```php title="Default value"
'#eba211'
```
## Tasks
### slack:notify
@ -145,18 +192,22 @@ Color of attachment
### slack:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22slack%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
### slack:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22slack%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)
### slack:notify:rollback
[Source](https://github.com/deployphp/deployer/search?q=%22slack%3Anotify%3Arollback%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aslack.php)

44
docs/contrib/telegram.md
View File

@ -68,53 +68,76 @@ after('deploy:failed', 'telegram:notify:failure');
* Config
* [`telegram_title`](#telegram_title)
* [`telegram_token`](#telegram_token)
* [`telegram_chat_id`](#telegram_chat_id)
* [`telegram_url`](#telegram_url)
* [`telegram_text`](#telegram_text)
* [`telegram_success_text`](#telegram_success_text)
* [`telegram_failure_text`](#telegram_failure_text)
* Configuration
* [telegram_title](#telegram_title)
* [telegram_token](#telegram_token)
* [telegram_chat_id](#telegram_chat_id)
* [telegram_url](#telegram_url)
* [telegram_text](#telegram_text)
* [telegram_success_text](#telegram_success_text)
* [telegram_failure_text](#telegram_failure_text)
* Tasks
* [`telegram:notify`](#telegramnotify)
* [telegram:notify](#telegramnotify)
## Config
## Configuration
### telegram_title
[Source](https://github.com/deployphp/deployer/search?q=%22telegram_title%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Atelegram.php)
Title of project
### telegram_token
[Source](https://github.com/deployphp/deployer/search?q=%22telegram_token%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Atelegram.php)
Telegram settings
### telegram_chat_id
[Source](https://github.com/deployphp/deployer/search?q=%22telegram_chat_id%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Atelegram.php)
### telegram_url
[Source](https://github.com/deployphp/deployer/search?q=%22telegram_url%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Atelegram.php)
### telegram_text
[Source](https://github.com/deployphp/deployer/search?q=%22telegram_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Atelegram.php)
Deploy message
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
```
### telegram_success_text
[Source](https://github.com/deployphp/deployer/search?q=%22telegram_success_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Atelegram.php)
```php title="Default value"
'Deploy to *{{target}}* successful'
```
### telegram_failure_text
[Source](https://github.com/deployphp/deployer/search?q=%22telegram_failure_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Atelegram.php)
```php title="Default value"
'Deploy to *{{target}}* failed'
```
## Tasks
### telegram:notify
@ -122,3 +145,4 @@ Deploy message

7
docs/contrib/webpack_encore.md
View File

@ -32,10 +32,10 @@ after('deploy:update_code', 'webpack_encore:build');
* Require
* [`contrib/npm.php`](/docs/contrib/npm.md)
* [`contrib/yarn.php`](/docs/contrib/yarn.md)
* [npm](/docs/contrib/npm.md)
* [yarn](/docs/contrib/yarn.md)
* Tasks
* [`webpack_encore:build`](#webpack_encorebuild) — Run webpack encore build
* [webpack_encore:build](#webpack_encorebuild) — Run webpack encore build
## Tasks
@ -44,3 +44,4 @@ after('deploy:update_code', 'webpack_encore:build');

41
docs/contrib/workplace.md
View File

@ -77,37 +77,57 @@ after('deploy:failed', 'workplace:notify:failure');
* Config
* [`workplace_text`](#workplace_text)
* [`workplace_success_text`](#workplace_success_text)
* [`workplace_failure_text`](#workplace_failure_text)
* [`workplace_edit_post`](#workplace_edit_post)
* Configuration
* [workplace_text](#workplace_text)
* [workplace_success_text](#workplace_success_text)
* [workplace_failure_text](#workplace_failure_text)
* [workplace_edit_post](#workplace_edit_post)
* Tasks
* [`workplace:notify`](#workplacenotify) — Notifying Workplace
* [`workplace:notify:success`](#workplacenotifysuccess) — Notifying Workplace about deploy finish
* [`workplace:notify:failure`](#workplacenotifyfailure) — Notifying Workplace about deploy failure
* [workplace:notify](#workplacenotify) — Notifying Workplace
* [workplace:notify:success](#workplacenotifysuccess) — Notifying Workplace about deploy finish
* [workplace:notify:failure](#workplacenotifyfailure) — Notifying Workplace about deploy failure
## Config
## Configuration
### workplace_text
[Source](https://github.com/deployphp/deployer/search?q=%22workplace_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aworkplace.php)
Deploy message
```php title="Default value"
'_{{user}}_ deploying `{{branch}}` to *{{target}}*'
```
### workplace_success_text
[Source](https://github.com/deployphp/deployer/search?q=%22workplace_success_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aworkplace.php)
```php title="Default value"
'Deploy to *{{target}}* successful'
```
### workplace_failure_text
[Source](https://github.com/deployphp/deployer/search?q=%22workplace_failure_text%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aworkplace.php)
```php title="Default value"
'Deploy to *{{target}}* failed'
```
### workplace_edit_post
[Source](https://github.com/deployphp/deployer/search?q=%22workplace_edit_post%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aworkplace.php)
By default, create a new post for every message
```php title="Default value"
false
```
## Tasks
### workplace:notify
@ -115,13 +135,16 @@ By default, create a new post for every message
### workplace:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22workplace%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aworkplace.php)
### workplace:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22workplace%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Aworkplace.php)

45
docs/contrib/yammer.md
View File

@ -64,43 +64,65 @@ after('deploy:failed', 'yammer:notify:failure');
* Config
* [`yammer_url`](#yammer_url)
* [`yammer_title`](#yammer_title)
* [`yammer_body`](#yammer_body)
* [`yammer_success_body`](#yammer_success_body)
* [`yammer_failure_body`](#yammer_failure_body)
* Configuration
* [yammer_url](#yammer_url)
* [yammer_title](#yammer_title)
* [yammer_body](#yammer_body)
* [yammer_success_body](#yammer_success_body)
* [yammer_failure_body](#yammer_failure_body)
* Tasks
* [`yammer:notify`](#yammernotify) — Notifying Yammer
* [`yammer:notify:success`](#yammernotifysuccess) — Notifying Yammer about deploy finish
* [`yammer:notify:failure`](#yammernotifyfailure) — Notifying Yammer about deploy failure
* [yammer:notify](#yammernotify) — Notifying Yammer
* [yammer:notify:success](#yammernotifysuccess) — Notifying Yammer about deploy finish
* [yammer:notify:failure](#yammernotifyfailure) — Notifying Yammer about deploy failure
## Config
## Configuration
### yammer_url
[Source](https://github.com/deployphp/deployer/search?q=%22yammer_url%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ayammer.php)
```php title="Default value"
'https://www.yammer.com/api/v1/messages.json'
```
### yammer_title
[Source](https://github.com/deployphp/deployer/search?q=%22yammer_title%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ayammer.php)
Title of project
### yammer_body
[Source](https://github.com/deployphp/deployer/search?q=%22yammer_body%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ayammer.php)
Deploy message
```php title="Default value"
'<em>{{user}}</em> deploying {{branch}} to <strong>{{target}}</strong>'
```
### yammer_success_body
[Source](https://github.com/deployphp/deployer/search?q=%22yammer_success_body%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ayammer.php)
```php title="Default value"
'Deploy to <strong>{{target}}</strong> successful'
```
### yammer_failure_body
[Source](https://github.com/deployphp/deployer/search?q=%22yammer_failure_body%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ayammer.php)
```php title="Default value"
'Deploy to <strong>{{target}}</strong> failed'
```
## Tasks
### yammer:notify
@ -108,13 +130,16 @@ Deploy message
### yammer:notify:success
[Source](https://github.com/deployphp/deployer/search?q=%22yammer%3Anotify%3Asuccess%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ayammer.php)
### yammer:notify:failure
[Source](https://github.com/deployphp/deployer/search?q=%22yammer%3Anotify%3Afailure%22+in%3Afile+language%3Aphp+path%3Acontrib+filename%3Ayammer.php)

3
docs/contrib/yarn.md
View File

@ -27,7 +27,7 @@ after('deploy:update_code', 'yarn:install');
* Tasks
* [`yarn:install`](#yarninstall) — Install Yarn packages
* [yarn:install](#yarninstall) — Install Yarn packages
## Tasks
@ -36,3 +36,4 @@ after('deploy:update_code', 'yarn:install');
In there is a {{previous_release}}, node_modules will be copied from it before installing deps with yarn.

37
docs/recipe/cakephp.md
View File

@ -9,52 +9,59 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_dirs`](#shared_dirs)
* [`shared_files`](#shared_files)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_dirs](#shared_dirs)
* [shared_files](#shared_files)
* Tasks
* [`deploy:init`](#deployinit)
* [`deploy:run_migrations`](#deployrun_migrations)
* [`deploy`](#deploy)
* [deploy:init](#deployinit)
* [deploy:run_migrations](#deployrun_migrations)
* [deploy](#deploy)
## Config
## Configuration
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acakephp.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
CakePHP 4 Project Template shared dirs
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acakephp.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
CakePHP 4 Project Template shared files
## Tasks
### deploy:init
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Ainit%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acakephp.php)
Create plugins' symlinks
### deploy:run_migrations
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Arun_migrations%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acakephp.php)
Run migrations
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acakephp.php)
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:init`](/docs/recipe/cakephp.md#deployinit)
* [`deploy:run_migrations`](/docs/recipe/cakephp.md#deployrun_migrations)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:init](/docs/recipe/cakephp.md#deployinit)
* [deploy:run_migrations](/docs/recipe/cakephp.md#deployrun_migrations)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

33
docs/recipe/codeigniter.md
View File

@ -9,28 +9,38 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_dirs`](#shared_dirs)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_dirs](#shared_dirs)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acodeigniter.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
CodeIgniter shared dirs
```php title="Default value"
['application/cache', 'application/logs']
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acodeigniter.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
CodeIgniter writable dirs
```php title="Default value"
['application/cache', 'application/logs']
```
## Tasks
### deploy
@ -38,9 +48,10 @@ CodeIgniter writable dirs
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

153
docs/recipe/common.md
View File

@ -9,46 +9,46 @@
* Require
* [`recipe/deploy/check_remote.php`](/docs/recipe/deploy/check_remote.md)
* [`recipe/deploy/cleanup.php`](/docs/recipe/deploy/cleanup.md)
* [`recipe/deploy/clear_paths.php`](/docs/recipe/deploy/clear_paths.md)
* [`recipe/deploy/copy_dirs.php`](/docs/recipe/deploy/copy_dirs.md)
* [`recipe/deploy/info.php`](/docs/recipe/deploy/info.md)
* [`recipe/deploy/lock.php`](/docs/recipe/deploy/lock.md)
* [`recipe/deploy/push.php`](/docs/recipe/deploy/push.md)
* [`recipe/deploy/release.php`](/docs/recipe/deploy/release.md)
* [`recipe/deploy/rollback.php`](/docs/recipe/deploy/rollback.md)
* [`recipe/deploy/setup.php`](/docs/recipe/deploy/setup.md)
* [`recipe/deploy/shared.php`](/docs/recipe/deploy/shared.md)
* [`recipe/deploy/status.php`](/docs/recipe/deploy/status.md)
* [`recipe/deploy/symlink.php`](/docs/recipe/deploy/symlink.md)
* [`recipe/deploy/update_code.php`](/docs/recipe/deploy/update_code.md)
* [`recipe/deploy/vendors.php`](/docs/recipe/deploy/vendors.md)
* [`recipe/deploy/writable.php`](/docs/recipe/deploy/writable.md)
* Config
* [`user`](#user)
* [`keep_releases`](#keep_releases)
* [`repository`](#repository)
* [`shared_dirs`](#shared_dirs)
* [`shared_files`](#shared_files)
* [`copy_dirs`](#copy_dirs)
* [`clear_paths`](#clear_paths)
* [`clear_use_sudo`](#clear_use_sudo)
* [`use_relative_symlink`](#use_relative_symlink)
* [`use_atomic_symlink`](#use_atomic_symlink)
* [`default_timeout`](#default_timeout)
* [`env`](#env)
* [`dotenv`](#dotenv)
* [`current_path`](#current_path)
* [`sudo_askpass`](#sudo_askpass)
* [check_remote](/docs/recipe/deploy/check_remote.md)
* [cleanup](/docs/recipe/deploy/cleanup.md)
* [clear_paths](/docs/recipe/deploy/clear_paths.md)
* [copy_dirs](/docs/recipe/deploy/copy_dirs.md)
* [info](/docs/recipe/deploy/info.md)
* [lock](/docs/recipe/deploy/lock.md)
* [push](/docs/recipe/deploy/push.md)
* [release](/docs/recipe/deploy/release.md)
* [rollback](/docs/recipe/deploy/rollback.md)
* [setup](/docs/recipe/deploy/setup.md)
* [shared](/docs/recipe/deploy/shared.md)
* [status](/docs/recipe/deploy/status.md)
* [symlink](/docs/recipe/deploy/symlink.md)
* [update_code](/docs/recipe/deploy/update_code.md)
* [vendors](/docs/recipe/deploy/vendors.md)
* [writable](/docs/recipe/deploy/writable.md)
* Configuration
* [user](#user)
* [keep_releases](#keep_releases)
* [repository](#repository)
* [shared_dirs](#shared_dirs)
* [shared_files](#shared_files)
* [copy_dirs](#copy_dirs)
* [clear_paths](#clear_paths)
* [clear_use_sudo](#clear_use_sudo)
* [use_relative_symlink](#use_relative_symlink)
* [use_atomic_symlink](#use_atomic_symlink)
* [default_timeout](#default_timeout)
* [env](#env)
* [dotenv](#dotenv)
* [current_path](#current_path)
* [sudo_askpass](#sudo_askpass)
* Tasks
* [`deploy:prepare`](#deployprepare)
* [`deploy:publish`](#deploypublish)
* [`deploy:success`](#deploysuccess)
* [`deploy:failed`](#deployfailed)
* [`logs`](#logs) — Follow latest application logs.
* [deploy:prepare](#deployprepare)
* [deploy:publish](#deploypublish)
* [deploy:success](#deploysuccess)
* [deploy:failed](#deployfailed)
* [logs](#logs) — Follow latest application logs.
## Config
## Configuration
### user
[Source](https://github.com/deployphp/deployer/search?q=%22user%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
@ -57,16 +57,25 @@ It will be shown in `dep status` command as author.
If not set will try automatically get git user name,
otherwise output of `whoami` command.
### keep_releases
[Source](https://github.com/deployphp/deployer/search?q=%22keep_releases%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
Number of releases to preserve in releases folder.
```php title="Default value"
5
```
### repository
[Source](https://github.com/deployphp/deployer/search?q=%22repository%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
Repository to deploy.
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
@ -76,6 +85,8 @@ Each release will have symlink to those dirs stored in {{deploy_path}}/shared di
set('shared_dirs', ['storage']);
```
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
@ -85,38 +96,59 @@ Each release will have symlink to those files stored in {{deploy_path}}/shared d
set('shared_files', ['.env']);
```
### copy_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22copy_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
List of dirs to copy between releases.
For example you can copy `node_modules` to speedup npm install.
### clear_paths
[Source](https://github.com/deployphp/deployer/search?q=%22clear_paths%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
List of paths to remove from [release_path](/docs/recipe/deploy/release.md#release_path).
### clear_use_sudo
[Source](https://github.com/deployphp/deployer/search?q=%22clear_use_sudo%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
Use sudo for deploy:clear_path task?
```php title="Default value"
false
```
### use_relative_symlink
[Source](https://github.com/deployphp/deployer/search?q=%22use_relative_symlink%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
### use_atomic_symlink
[Source](https://github.com/deployphp/deployer/search?q=%22use_atomic_symlink%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
### default_timeout
[Source](https://github.com/deployphp/deployer/search?q=%22default_timeout%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
Default timeout for `run()` and `runLocally()` functions. Default to 300 seconds.
Default timeout for `run()` and `runLocally()` functions.
Set to `null` to disable timeout.
```php title="Default value"
300
```
### env
[Source](https://github.com/deployphp/deployer/search?q=%22env%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
@ -133,15 +165,22 @@ It is possible to override it per `run()` call.
run('echo $KEY', ['env' => ['KEY' => 'over']]
```
### dotenv
[Source](https://github.com/deployphp/deployer/search?q=%22dotenv%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
Path to `.env` file which will be used as environment variables for each command per `run()`.
```php
set('dotenv', '[current_path](/docs/recipe/common.md#current_path)/.env');
set('dotenv', '{{current_path}}/.env');
```
```php title="Default value"
false
```
### current_path
[Source](https://github.com/deployphp/deployer/search?q=%22current_path%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
@ -150,6 +189,11 @@ Return current release path. Default to {{deploy_path}}/`current`.
set('current_path', '/var/public_html');
```
```php title="Default value"
'{{deploy_path}}/current'
```
### sudo_askpass
[Source](https://github.com/deployphp/deployer/search?q=%22sudo_askpass%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
@ -158,20 +202,23 @@ Defaults to `.dep/sudo_pass`. This script is only temporary and will be deleted
sudo command executed.
## Tasks
### deploy:prepare
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Aprepare%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
This task is group task which contains next tasks:
* [`deploy:info`](/docs/recipe/deploy/info.md#deployinfo)
* [`deploy:setup`](/docs/recipe/deploy/setup.md#deploysetup)
* [`deploy:lock`](/docs/recipe/deploy/lock.md#deploylock)
* [`deploy:release`](/docs/recipe/deploy/release.md#deployrelease)
* [`deploy:update_code`](/docs/recipe/deploy/update_code.md#deployupdate_code)
* [`deploy:shared`](/docs/recipe/deploy/shared.md#deployshared)
* [`deploy:writable`](/docs/recipe/deploy/writable.md#deploywritable)
* [deploy:info](/docs/recipe/deploy/info.md#deployinfo)
* [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup)
* [deploy:lock](/docs/recipe/deploy/lock.md#deploylock)
* [deploy:release](/docs/recipe/deploy/release.md#deployrelease)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)
* [deploy:shared](/docs/recipe/deploy/shared.md#deployshared)
* [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable)
### deploy:publish
@ -179,11 +226,12 @@ This task is group task which contains next tasks:
This task is group task which contains next tasks:
* [`deploy:symlink`](/docs/recipe/deploy/symlink.md#deploysymlink)
* [`deploy:unlock`](/docs/recipe/deploy/lock.md#deployunlock)
* [`deploy:cleanup`](/docs/recipe/deploy/cleanup.md#deploycleanup)
* [`deploy:success`](/docs/recipe/common.md#deploysuccess)
* [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink)
* [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock)
* [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup)
* [deploy:success](/docs/recipe/common.md#deploysuccess)
### deploy:success
@ -191,13 +239,16 @@ This task is group task which contains next tasks:
Prints success message
### deploy:failed
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Afailed%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
Hook on deploy failure.
### logs
[Source](https://github.com/deployphp/deployer/search?q=%22logs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Acommon.php)
Follow latest application logs.

11
docs/recipe/composer.md
View File

@ -9,9 +9,9 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* [common](/docs/recipe/common.md)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Tasks
@ -20,9 +20,10 @@
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

3
docs/recipe/deploy/check_remote.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`deploy:check_remote`](#deploycheck_remote) — Check remote head
* [deploy:check_remote](#deploycheck_remote) — Check remote head
## Tasks
@ -19,3 +19,4 @@
Cancel deployment if there would be no change to the codebase.
This avoids unnecessary releases if the latest commit has already been deployed.

14
docs/recipe/deploy/cleanup.md
View File

@ -8,17 +8,22 @@
* Config
* [`cleanup_use_sudo`](#cleanup_use_sudo)
* Configuration
* [cleanup_use_sudo](#cleanup_use_sudo)
* Tasks
* [`deploy:cleanup`](#deploycleanup) — Cleaning up old releases
* [deploy:cleanup](#deploycleanup) — Cleaning up old releases
## Config
## Configuration
### cleanup_use_sudo
[Source](https://github.com/deployphp/deployer/search?q=%22cleanup_use_sudo%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Acleanup.php)
Use sudo in deploy:cleanup task for rm command.
```php title="Default value"
false
```
## Tasks
### deploy:cleanup
@ -26,3 +31,4 @@ Use sudo in deploy:cleanup task for rm command.

3
docs/recipe/deploy/clear_paths.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`deploy:clear_paths`](#deployclear_paths) — Cleaning up files and/or directories
* [deploy:clear_paths](#deployclear_paths) — Cleaning up files and/or directories
## Tasks
@ -18,3 +18,4 @@

3
docs/recipe/deploy/copy_dirs.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`deploy:copy_dirs`](#deploycopy_dirs) — Copy directories
* [deploy:copy_dirs](#deploycopy_dirs) — Copy directories
## Tasks
@ -18,3 +18,4 @@

11
docs/recipe/deploy/info.md
View File

@ -8,21 +8,24 @@
* Config
* [`target`](#target)
* Configuration
* [target](#target)
* Tasks
* [`deploy:info`](#deployinfo)
* [deploy:info](#deployinfo)
## Config
## Configuration
### target
[Source](https://github.com/deployphp/deployer/search?q=%22target%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Ainfo.php)
Holds name of deployed branch, tag or revision.
## Tasks
### deploy:info
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Ainfo%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Ainfo.php)

9
docs/recipe/deploy/lock.md
View File

@ -9,9 +9,9 @@
* Tasks
* [`deploy:lock`](#deploylock) — Lock deploy
* [`deploy:unlock`](#deployunlock) — Unlock deploy
* [`deploy:is-unlocked`](#deployis-unlocked) — Check if deploy is unlocked
* [deploy:lock](#deploylock) — Lock deploy
* [deploy:unlock](#deployunlock) — Unlock deploy
* [deploy:is-unlocked](#deployis-unlocked) — Check if deploy is unlocked
## Tasks
@ -20,13 +20,16 @@
### deploy:unlock
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Aunlock%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Alock.php)
### deploy:is-unlocked
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Ais-unlocked%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Alock.php)

3
docs/recipe/deploy/push.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`push`](#push) — Push local changes to remote host
* [push](#push) — Push local changes to remote host
## Tasks
@ -20,3 +20,4 @@ Creates patch of local changes and pushes them on host.
And applies to current_path. Push can be done many times.
The task purpose to be used only for development.

27
docs/recipe/deploy/release.md
View File

@ -8,36 +8,44 @@
* Config
* [`release_name`](#release_name)
* [`releases_metainfo`](#releases_metainfo)
* [`releases_list`](#releases_list)
* [`release_path`](#release_path)
* [`release_or_current_path`](#release_or_current_path)
* Configuration
* [release_name](#release_name)
* [releases_metainfo](#releases_metainfo)
* [releases_list](#releases_list)
* [release_path](#release_path)
* [release_or_current_path](#release_or_current_path)
* Tasks
* [`deploy:release`](#deployrelease) — Prepare release. Clean up unfinished releases and prepare next release
* [deploy:release](#deployrelease) — Prepare release. Clean up unfinished releases and prepare next release
## Config
## Configuration
### release_name
[Source](https://github.com/deployphp/deployer/search?q=%22release_name%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Arelease.php)
Name of folder in releases.
### releases_metainfo
[Source](https://github.com/deployphp/deployer/search?q=%22releases_metainfo%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Arelease.php)
Holds metainfo about releases from `.dep/releases` file.
### releases_list
[Source](https://github.com/deployphp/deployer/search?q=%22releases_list%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Arelease.php)
Return list of releases on host.
### release_path
[Source](https://github.com/deployphp/deployer/search?q=%22release_path%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Arelease.php)
Return release path.
### release_or_current_path
[Source](https://github.com/deployphp/deployer/search?q=%22release_or_current_path%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Arelease.php)
@ -45,9 +53,12 @@ Return the release path during a deployment
but fallback to the current path otherwise.
## Tasks
### deploy:release
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Arelease%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Arelease.php)

3
docs/recipe/deploy/rollback.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`rollback`](#rollback) — Rollback to previous release
* [rollback](#rollback) — Rollback to previous release
## Tasks
@ -18,3 +18,4 @@

3
docs/recipe/deploy/setup.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`deploy:setup`](#deploysetup) — Preparing host for deploy
* [deploy:setup](#deploysetup) — Preparing host for deploy
## Tasks
@ -18,3 +18,4 @@

3
docs/recipe/deploy/shared.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`deploy:shared`](#deployshared) — Creating symlinks for shared files and dirs
* [deploy:shared](#deployshared) — Creating symlinks for shared files and dirs
## Tasks
@ -18,3 +18,4 @@

3
docs/recipe/deploy/status.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`status`](#status) — Show releases status
* [status](#status) — Show releases status
## Tasks
@ -18,3 +18,4 @@

3
docs/recipe/deploy/symlink.md
View File

@ -9,7 +9,7 @@
* Tasks
* [`deploy:symlink`](#deploysymlink) — Creating symlink to release
* [deploy:symlink](#deploysymlink) — Creating symlink to release
## Tasks
@ -18,3 +18,4 @@

11
docs/recipe/deploy/update_code.md
View File

@ -8,12 +8,12 @@
* Config
* [`branch`](#branch)
* Configuration
* [branch](#branch)
* Tasks
* [`deploy:update_code`](#deployupdate_code) — Update code
* [deploy:update_code](#deployupdate_code) — Update code
## Config
## Configuration
### branch
[Source](https://github.com/deployphp/deployer/search?q=%22branch%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Aupdate_code.php)
@ -21,9 +21,12 @@ Determines which branch to deploy. Can be overridden with cli option `--branch`.
If not specified, will get current git HEAD branch as default branch to deploy.
## Tasks
### deploy:update_code
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Aupdate_code%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Aupdate_code.php)
Update code at [release_path](/docs/recipe/deploy/release.md#release_path) on host.

21
docs/recipe/deploy/vendors.md
View File

@ -8,23 +8,33 @@
* Config
* [`composer_action`](#composer_action)
* [`composer_options`](#composer_options)
* Configuration
* [composer_action](#composer_action)
* [composer_options](#composer_options)
* Tasks
* [`deploy:vendors`](#deployvendors) — Installing vendors
* [deploy:vendors](#deployvendors) — Installing vendors
## Config
## Configuration
### composer_action
[Source](https://github.com/deployphp/deployer/search?q=%22composer_action%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Avendors.php)
```php title="Default value"
'install'
```
### composer_options
[Source](https://github.com/deployphp/deployer/search?q=%22composer_options%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Avendors.php)
```php title="Default value"
'--verbose --prefer-dist --no-progress --no-interaction --no-dev --optimize-autoloader'
```
## Tasks
### deploy:vendors
@ -32,3 +42,4 @@

57
docs/recipe/deploy/writable.md
View File

@ -8,59 +8,93 @@
* Config
* [`http_user`](#http_user)
* [`http_group`](#http_group)
* [`writable_dirs`](#writable_dirs)
* [`writable_mode`](#writable_mode)
* [`writable_use_sudo`](#writable_use_sudo)
* [`writable_recursive`](#writable_recursive)
* [`writable_chmod_mode`](#writable_chmod_mode)
* [`writable_chmod_recursive`](#writable_chmod_recursive)
* Configuration
* [http_user](#http_user)
* [http_group](#http_group)
* [writable_dirs](#writable_dirs)
* [writable_mode](#writable_mode)
* [writable_use_sudo](#writable_use_sudo)
* [writable_recursive](#writable_recursive)
* [writable_chmod_mode](#writable_chmod_mode)
* [writable_chmod_recursive](#writable_chmod_recursive)
* Tasks
* [`deploy:writable`](#deploywritable) — Make writable dirs
* [deploy:writable](#deploywritable) — Make writable dirs
## Config
## Configuration
### http_user
[Source](https://github.com/deployphp/deployer/search?q=%22http_user%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Awritable.php)
Attempts automatically to detect http user in process list.
### http_group
[Source](https://github.com/deployphp/deployer/search?q=%22http_group%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Awritable.php)
```php title="Default value"
false
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Awritable.php)
List of writable dirs.
### writable_mode
[Source](https://github.com/deployphp/deployer/search?q=%22writable_mode%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Awritable.php)
chmod, chown, chgrp or acl.
```php title="Default value"
'acl'
```
### writable_use_sudo
[Source](https://github.com/deployphp/deployer/search?q=%22writable_use_sudo%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Awritable.php)
Using sudo in writable commands?
```php title="Default value"
false
```
### writable_recursive
[Source](https://github.com/deployphp/deployer/search?q=%22writable_recursive%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Awritable.php)
Common for all modes
```php title="Default value"
true
```
### writable_chmod_mode
[Source](https://github.com/deployphp/deployer/search?q=%22writable_chmod_mode%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Awritable.php)
For chmod mode
```php title="Default value"
'0755'
```
### writable_chmod_recursive
[Source](https://github.com/deployphp/deployer/search?q=%22writable_chmod_recursive%22+in%3Afile+language%3Aphp+path%3Arecipe%2Fdeploy+filename%3Awritable.php)
For chmod mode only (if is boolean, it has priority over `writable_recursive`)
```php title="Default value"
true
```
## Tasks
### deploy:writable
@ -68,3 +102,4 @@ For chmod mode only (if is boolean, it has priority over `writable_recursive`)

44
docs/recipe/drupal7.md
View File

@ -9,54 +9,66 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`drupal_site`](#drupal_site)
* [`shared_dirs`](#shared_dirs)
* [`shared_files`](#shared_files)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [drupal_site](#drupal_site)
* [shared_dirs](#shared_dirs)
* [shared_files](#shared_files)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy`](#deploy)
* [`drupal:settings`](#drupalsettings)
* [`drupal:upload_files`](#drupalupload_files)
* [deploy](#deploy)
* [drupal:settings](#drupalsettings)
* [drupal:upload_files](#drupalupload_files)
## Config
## Configuration
### drupal_site
[Source](https://github.com/deployphp/deployer/search?q=%22drupal_site%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal7.php)
Set Drupal 7 site. Change if you use different site
```php title="Default value"
'default'
```
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal7.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
Drupal 7 shared dirs
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal7.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
Drupal 7 shared files
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal7.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
Drupal 7 writable dirs
## Tasks
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal7.php)
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:publish](/docs/recipe/common.md#deploypublish)
### drupal:settings
@ -64,8 +76,10 @@ This task is group task which contains next tasks:
Create and upload Drupal 7 settings.php using values from secrets
### drupal:upload_files
[Source](https://github.com/deployphp/deployer/search?q=%22drupal%3Aupload_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal7.php)
Upload Drupal 7 files folder

38
docs/recipe/drupal8.md
View File

@ -9,51 +9,63 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`drupal_site`](#drupal_site)
* [`shared_dirs`](#shared_dirs)
* [`shared_files`](#shared_files)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [drupal_site](#drupal_site)
* [shared_dirs](#shared_dirs)
* [shared_files](#shared_files)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy`](#deploy)
* [deploy](#deploy)
## Config
## Configuration
### drupal_site
[Source](https://github.com/deployphp/deployer/search?q=%22drupal_site%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal8.php)
Set drupal site. Change if you use different site
```php title="Default value"
'default'
```
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal8.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
Drupal 8 shared dirs
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal8.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
Drupal 8 shared files
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal8.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
Drupal 8 Writable dirs
## Tasks
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Adrupal8.php)
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

45
docs/recipe/flow_framework.md
View File

@ -9,56 +9,71 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`flow_context`](#flow_context)
* [`flow_command`](#flow_command)
* [`shared_dirs`](#shared_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [flow_context](#flow_context)
* [flow_command](#flow_command)
* [shared_dirs](#shared_dirs)
* Tasks
* [`deploy:run_migrations`](#deployrun_migrations) — Apply database migrations
* [`deploy:publish_resources`](#deploypublish_resources) — Publish resources
* [`deploy`](#deploy) — Deploy your project
* [deploy:run_migrations](#deployrun_migrations) — Apply database migrations
* [deploy:publish_resources](#deploypublish_resources) — Publish resources
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### flow_context
[Source](https://github.com/deployphp/deployer/search?q=%22flow_context%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aflow_framework.php)
Flow-Framework application-context
```php title="Default value"
'Production'
```
### flow_command
[Source](https://github.com/deployphp/deployer/search?q=%22flow_command%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aflow_framework.php)
Flow-Framework cli-command
```php title="Default value"
'flow'
```
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aflow_framework.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
Flow-Framework shared directories
## Tasks
### deploy:run_migrations
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Arun_migrations%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aflow_framework.php)
Apply database migrations
### deploy:publish_resources
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Apublish_resources%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aflow_framework.php)
Publish resources
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aflow_framework.php)
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:run_migrations`](/docs/recipe/flow_framework.md#deployrun_migrations)
* [`deploy:publish_resources`](/docs/recipe/flow_framework.md#deploypublish_resources)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:run_migrations](/docs/recipe/flow_framework.md#deployrun_migrations)
* [deploy:publish_resources](/docs/recipe/flow_framework.md#deploypublish_resources)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

21
docs/recipe/fuelphp.md
View File

@ -9,30 +9,33 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_dirs`](#shared_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_dirs](#shared_dirs)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Afuelphp.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
FuelPHP 1.x shared dirs
## Tasks
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Afuelphp.php)
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

40
docs/recipe/joomla.md
View File

@ -9,36 +9,51 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_files`](#shared_files)
* [`shared_dirs`](#shared_dirs)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_files](#shared_files)
* [shared_dirs](#shared_dirs)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ajoomla.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
```php title="Default value"
['configuration.php']
```
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ajoomla.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
```php title="Default value"
['images']
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ajoomla.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
```php title="Default value"
['images']
```
## Tasks
### deploy
@ -46,8 +61,9 @@
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

170
docs/recipe/laravel.md
View File

@ -9,71 +9,83 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_dirs`](#shared_dirs)
* [`shared_files`](#shared_files)
* [`writable_dirs`](#writable_dirs)
* [`log_files`](#log_files)
* [`laravel_version`](#laravel_version)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_dirs](#shared_dirs)
* [shared_files](#shared_files)
* [writable_dirs](#writable_dirs)
* [log_files](#log_files)
* [laravel_version](#laravel_version)
* Tasks
* [`artisan:down`](#artisandown) — Put the application into maintenance / demo mode
* [`artisan:up`](#artisanup) — Bring the application out of maintenance mode
* [`artisan:key:generate`](#artisankeygenerate) — Set the application key
* [`artisan:passport:keys`](#artisanpassportkeys) — Create the encryption keys for API authentication
* [`artisan:db:seed`](#artisandbseed) — Seed the database with records
* [`artisan:migrate`](#artisanmigrate) — Run the database migrations
* [`artisan:migrate:fresh`](#artisanmigratefresh) — Drop all tables and re-run all migrations
* [`artisan:migrate:rollback`](#artisanmigraterollback) — Rollback the last database migration
* [`artisan:migrate:status`](#artisanmigratestatus) — Show the status of each migration
* [`artisan:cache:clear`](#artisancacheclear) — Flush the application cache
* [`artisan:config:cache`](#artisanconfigcache) — Create a cache file for faster configuration loading
* [`artisan:config:clear`](#artisanconfigclear) — Remove the configuration cache file
* [`artisan:event:cache`](#artisaneventcache) — Discover and cache the application\'s events and listeners
* [`artisan:event:clear`](#artisaneventclear) — Clear all cached events and listeners
* [`artisan:event:list`](#artisaneventlist) — List the application\'s events and listeners
* [`artisan:optimize`](#artisanoptimize) — Cache the framework bootstrap files
* [`artisan:optimize:clear`](#artisanoptimizeclear) — Remove the cached bootstrap files
* [`artisan:route:cache`](#artisanroutecache) — Create a route cache file for faster route registration
* [`artisan:route:clear`](#artisanrouteclear) — Remove the route cache file
* [`artisan:route:list`](#artisanroutelist) — List all registered routes
* [`artisan:storage:link`](#artisanstoragelink) — Create the symbolic links configured for the application
* [`artisan:view:cache`](#artisanviewcache) — Compile all of the application\'s Blade templates
* [`artisan:view:clear`](#artisanviewclear) — Clear all compiled view files
* [`artisan:queue:failed`](#artisanqueuefailed) — List all of the failed queue jobs
* [`artisan:queue:flush`](#artisanqueueflush) — Flush all of the failed queue jobs
* [`artisan:queue:restart`](#artisanqueuerestart) — Restart queue worker daemons after their current job
* [`artisan:horizon`](#artisanhorizon) — Start a master supervisor in the foreground
* [`artisan:horizon:clear`](#artisanhorizonclear) — Delete all of the jobs from the specified queue
* [`artisan:horizon:continue`](#artisanhorizoncontinue) — Instruct the master supervisor to continue processing jobs
* [`artisan:horizon:list`](#artisanhorizonlist) — List all of the deployed machines
* [`artisan:horizon:pause`](#artisanhorizonpause) — Pause the master supervisor
* [`artisan:horizon:purge`](#artisanhorizonpurge) — Terminate any rogue Horizon processes
* [`artisan:horizon:status`](#artisanhorizonstatus) — Get the current status of Horizon
* [`artisan:horizon:terminate`](#artisanhorizonterminate) — Terminate the master supervisor so it can be restarted
* [`artisan:telescope:clear`](#artisantelescopeclear) — Clear all entries from Telescope
* [`artisan:telescope:prune`](#artisantelescopeprune) — Prune stale entries from the Telescope database
* [`deploy`](#deploy) — Deploy your project
* [artisan:down](#artisandown) — Put the application into maintenance / demo mode
* [artisan:up](#artisanup) — Bring the application out of maintenance mode
* [artisan:&#8203;key:generate](#artisankeygenerate) — Set the application key
* [artisan:passport:keys](#artisanpassportkeys) — Create the encryption keys for API authentication
* [artisan:db:seed](#artisandbseed) — Seed the database with records
* [artisan:migrate](#artisanmigrate) — Run the database migrations
* [artisan:migrate:fresh](#artisanmigratefresh) — Drop all tables and re-run all migrations
* [artisan:migrate:rollback](#artisanmigraterollback) — Rollback the last database migration
* [artisan:migrate:status](#artisanmigratestatus) — Show the status of each migration
* [artisan:cache:clear](#artisancacheclear) — Flush the application cache
* [artisan:config:cache](#artisanconfigcache) — Create a cache file for faster configuration loading
* [artisan:config:clear](#artisanconfigclear) — Remove the configuration cache file
* [artisan:event:cache](#artisaneventcache) — Discover and cache the application\'s events and listeners
* [artisan:event:clear](#artisaneventclear) — Clear all cached events and listeners
* [artisan:event:list](#artisaneventlist) — List the application\'s events and listeners
* [artisan:optimize](#artisanoptimize) — Cache the framework bootstrap files
* [artisan:optimize:clear](#artisanoptimizeclear) — Remove the cached bootstrap files
* [artisan:route:cache](#artisanroutecache) — Create a route cache file for faster route registration
* [artisan:route:clear](#artisanrouteclear) — Remove the route cache file
* [artisan:route:list](#artisanroutelist) — List all registered routes
* [artisan:storage:link](#artisanstoragelink) — Create the symbolic links configured for the application
* [artisan:view:cache](#artisanviewcache) — Compile all of the application\'s Blade templates
* [artisan:view:clear](#artisanviewclear) — Clear all compiled view files
* [artisan:queue:failed](#artisanqueuefailed) — List all of the failed queue jobs
* [artisan:queue:flush](#artisanqueueflush) — Flush all of the failed queue jobs
* [artisan:queue:restart](#artisanqueuerestart) — Restart queue worker daemons after their current job
* [artisan:horizon](#artisanhorizon) — Start a master supervisor in the foreground
* [artisan:horizon:clear](#artisanhorizonclear) — Delete all of the jobs from the specified queue
* [artisan:horizon:continue](#artisanhorizoncontinue) — Instruct the master supervisor to continue processing jobs
* [artisan:horizon:list](#artisanhorizonlist) — List all of the deployed machines
* [artisan:horizon:pause](#artisanhorizonpause) — Pause the master supervisor
* [artisan:horizon:purge](#artisanhorizonpurge) — Terminate any rogue Horizon processes
* [artisan:horizon:status](#artisanhorizonstatus) — Get the current status of Horizon
* [artisan:horizon:terminate](#artisanhorizonterminate) — Terminate the master supervisor so it can be restarted
* [artisan:&#8203;telescope:clear](#artisantelescopeclear) — Clear all entries from Telescope
* [artisan:&#8203;telescope:prune](#artisantelescopeprune) — Prune stale entries from the Telescope database
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
```php title="Default value"
['storage']
```
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
```php title="Default value"
['.env']
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
@ -82,204 +94,248 @@
```php title="Default value"
'storage/logs/*.log'
```
### laravel_version
[Source](https://github.com/deployphp/deployer/search?q=%22laravel_version%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
## Tasks
### artisan:down
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Adown%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:up
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aup%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:key:generate
### artisan:&#8203;key:generate
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Akey%3Agenerate%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:passport:keys
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Apassport%3Akeys%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:db:seed
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Adb%3Aseed%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:migrate
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Amigrate%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:migrate:fresh
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Amigrate%3Afresh%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:migrate:rollback
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Amigrate%3Arollback%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:migrate:status
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Amigrate%3Astatus%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:cache:clear
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Acache%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:config:cache
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aconfig%3Acache%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:config:clear
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aconfig%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:event:cache
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aevent%3Acache%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:event:clear
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aevent%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:event:list
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aevent%3Alist%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:optimize
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aoptimize%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:optimize:clear
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aoptimize%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:route:cache
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aroute%3Acache%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:route:clear
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aroute%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:route:list
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aroute%3Alist%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:storage:link
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Astorage%3Alink%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:view:cache
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aview%3Acache%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:view:clear
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aview%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:queue:failed
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aqueue%3Afailed%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:queue:flush
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aqueue%3Aflush%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:queue:restart
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Aqueue%3Arestart%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:horizon
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Ahorizon%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:horizon:clear
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Ahorizon%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:horizon:continue
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Ahorizon%3Acontinue%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:horizon:list
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Ahorizon%3Alist%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:horizon:pause
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Ahorizon%3Apause%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:horizon:purge
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Ahorizon%3Apurge%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:horizon:status
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Ahorizon%3Astatus%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:horizon:terminate
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Ahorizon%3Aterminate%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:telescope:clear
### artisan:&#8203;telescope:clear
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Atelescope%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### artisan:telescope:prune
### artisan:&#8203;telescope:prune
[Source](https://github.com/deployphp/deployer/search?q=%22artisan%3Atelescope%3Aprune%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Alaravel.php)
Main deploy task.
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`artisan:storage:link`](/docs/recipe/laravel.md#artisanstoragelink)
* [`artisan:view:cache`](/docs/recipe/laravel.md#artisanviewcache)
* [`artisan:config:cache`](/docs/recipe/laravel.md#artisanconfigcache)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [artisan:storage:link](/docs/recipe/laravel.md#artisanstoragelink)
* [artisan:view:cache](/docs/recipe/laravel.md#artisanviewcache)
* [artisan:config:cache](/docs/recipe/laravel.md#artisanconfigcache)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

48
docs/recipe/magento.md
View File

@ -9,38 +9,53 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_dirs`](#shared_dirs)
* [`shared_files`](#shared_files)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_dirs](#shared_dirs)
* [shared_files](#shared_files)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy:cache:clear`](#deploycacheclear) — Clear cache
* [`deploy:clear_version`](#deployclear_version)
* [`deploy`](#deploy) — Deploy your project
* [deploy:cache:clear](#deploycacheclear) — Clear cache
* [deploy:clear_version](#deployclear_version)
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
Magento shared dirs
```php title="Default value"
['var', 'media']
```
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
Magento shared files
```php title="Default value"
['app/etc/local.xml']
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
Magento writable dirs
```php title="Default value"
['var', 'media']
```
## Tasks
### deploy:cache:clear
@ -48,19 +63,22 @@ Magento writable dirs
Clear cache
### deploy:clear_version
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Aclear_version%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento.php)
Remove files that can be used to compromise Magento
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento.php)
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:cache:clear`](/docs/recipe/magento.md#deploycacheclear)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:cache:clear](/docs/recipe/magento.md#deploycacheclear)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

97
docs/recipe/magento2.md
View File

@ -9,29 +9,29 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`static_content_locales`](#static_content_locales)
* [`content_version`](#content_version)
* [`shared_files`](#shared_files)
* [`shared_dirs`](#shared_dirs)
* [`writable_dirs`](#writable_dirs)
* [`clear_paths`](#clear_paths)
* [`magento_version`](#magento_version)
* [`maintenance_mode_status_active`](#maintenance_mode_status_active)
* [common](/docs/recipe/common.md)
* Configuration
* [static_content_locales](#static_content_locales)
* [content_version](#content_version)
* [shared_files](#shared_files)
* [shared_dirs](#shared_dirs)
* [writable_dirs](#writable_dirs)
* [clear_paths](#clear_paths)
* [magento_version](#magento_version)
* [maintenance_mode_status_active](#maintenance_mode_status_active)
* Tasks
* [`magento:compile`](#magentocompile) — Compile magento di
* [`magento:deploy:assets`](#magentodeployassets) — Deploy assets
* [`magento:sync:content_version`](#magentosynccontent_version) — Sync content version
* [`magento:maintenance:enable`](#magentomaintenanceenable) — Enable maintenance mode
* [`magento:maintenance:disable`](#magentomaintenancedisable) — Disable maintenance mode
* [`magento:config:import`](#magentoconfigimport) — Config Import
* [`magento:upgrade:db`](#magentoupgradedb) — Upgrade magento database
* [`magento:cache:flush`](#magentocacheflush) — Flush Magento Cache
* [`deploy:magento`](#deploymagento) — Magento2 deployment operations
* [`deploy`](#deploy) — Deploy your project
* [magento:compile](#magentocompile) — Compile magento di
* [magento:deploy:assets](#magentodeployassets) — Deploy assets
* [magento:sync:content_version](#magentosynccontent_version) — Sync content version
* [magento:maintenance:enable](#magentomaintenanceenable) — Enable maintenance mode
* [magento:maintenance:disable](#magentomaintenancedisable) — Disable maintenance mode
* [magento:config:import](#magentoconfigimport) — Config Import
* [magento:upgrade:db](#magentoupgradedb) — Upgrade magento database
* [magento:cache:flush](#magentocacheflush) — Flush Magento Cache
* [deploy:magento](#deploymagento) — Magento2 deployment operations
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### static_content_locales
[Source](https://github.com/deployphp/deployer/search?q=%22static_content_locales%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
@ -39,36 +39,51 @@ By default setup:static-content:deploy uses `en_US`.
To change that, simply put `set('static_content_locales', 'en_US de_DE');`
in you deployer script.
```php title="Default value"
'en_US'
```
### content_version
[Source](https://github.com/deployphp/deployer/search?q=%22content_version%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
### clear_paths
[Source](https://github.com/deployphp/deployer/search?q=%22clear_paths%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
* Overrides [`clear_paths`](/docs/recipe/common.md#clear_paths) from `recipe/common.php`
* Overrides [clear_paths](/docs/recipe/common.md#clear_paths) from `recipe/common.php`
@ -77,63 +92,76 @@ in you deployer script.
### maintenance_mode_status_active
[Source](https://github.com/deployphp/deployer/search?q=%22maintenance_mode_status_active%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
## Tasks
### magento:compile
[Source](https://github.com/deployphp/deployer/search?q=%22magento%3Acompile%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
Tasks
### magento:deploy:assets
[Source](https://github.com/deployphp/deployer/search?q=%22magento%3Adeploy%3Aassets%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
### magento:sync:content_version
[Source](https://github.com/deployphp/deployer/search?q=%22magento%3Async%3Acontent_version%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
### magento:maintenance:enable
[Source](https://github.com/deployphp/deployer/search?q=%22magento%3Amaintenance%3Aenable%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
### magento:maintenance:disable
[Source](https://github.com/deployphp/deployer/search?q=%22magento%3Amaintenance%3Adisable%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
### magento:config:import
[Source](https://github.com/deployphp/deployer/search?q=%22magento%3Aconfig%3Aimport%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
### magento:upgrade:db
[Source](https://github.com/deployphp/deployer/search?q=%22magento%3Aupgrade%3Adb%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
### magento:cache:flush
[Source](https://github.com/deployphp/deployer/search?q=%22magento%3Acache%3Aflush%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
### deploy:magento
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Amagento%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Amagento2.php)
This task is group task which contains next tasks:
* [`magento:compile`](/docs/recipe/magento2.md#magentocompile)
* [`magento:deploy:assets`](/docs/recipe/magento2.md#magentodeployassets)
* [`magento:config:import`](/docs/recipe/magento2.md#magentoconfigimport)
* [`magento:upgrade:db`](/docs/recipe/magento2.md#magentoupgradedb)
* [magento:compile](/docs/recipe/magento2.md#magentocompile)
* [magento:deploy:assets](/docs/recipe/magento2.md#magentodeployassets)
* [magento:config:import](/docs/recipe/magento2.md#magentoconfigimport)
* [magento:upgrade:db](/docs/recipe/magento2.md#magentoupgradedb)
### deploy
@ -141,11 +169,12 @@ This task is group task which contains next tasks:
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:clear_paths`](/docs/recipe/deploy/clear_paths.md#deployclear_paths)
* [`deploy:magento`](/docs/recipe/magento2.md#deploymagento)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deployclear_paths)
* [deploy:magento](/docs/recipe/magento2.md#deploymagento)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

33
docs/recipe/prestashop.md
View File

@ -9,33 +9,39 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_files`](#shared_files)
* [`shared_dirs`](#shared_dirs)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_files](#shared_files)
* [shared_dirs](#shared_dirs)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aprestashop.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aprestashop.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Aprestashop.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
@ -46,9 +52,10 @@
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

107
docs/recipe/shopware.md
View File

@ -9,63 +9,76 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`repository`](#repository)
* [`release_name`](#release_name)
* [`shared_files`](#shared_files)
* [`shared_dirs`](#shared_dirs)
* [`writable_dirs`](#writable_dirs)
* [`static_folders`](#static_folders)
* [common](/docs/recipe/common.md)
* Configuration
* [repository](#repository)
* [release_name](#release_name)
* [shared_files](#shared_files)
* [shared_dirs](#shared_dirs)
* [writable_dirs](#writable_dirs)
* [static_folders](#static_folders)
* Tasks
* [`sw:update_code`](#swupdate_code)
* [`sw:system:install`](#swsysteminstall)
* [`sw:build`](#swbuild)
* [`sw:system:setup`](#swsystemsetup)
* [`sw:theme:compile`](#swthemecompile)
* [`sw:cache:clear`](#swcacheclear)
* [`sw:cache:warmup`](#swcachewarmup)
* [`sw:database:migrate`](#swdatabasemigrate)
* [`sw:plugin:refresh`](#swpluginrefresh)
* [`sw:plugin:activate:all`](#swpluginactivateall)
* [`sw:plugin:migrate:all`](#swpluginmigrateall)
* [`sw:plugin:upgrade:all`](#swpluginupgradeall)
* [`sw:deploy`](#swdeploy)
* [`deploy`](#deploy) — Deploy your project
* [sw:update_code](#swupdate_code)
* [sw:system:install](#swsysteminstall)
* [sw:build](#swbuild)
* [sw:system:setup](#swsystemsetup)
* [sw:theme:compile](#swthemecompile)
* [sw:cache:clear](#swcacheclear)
* [sw:cache:warmup](#swcachewarmup)
* [sw:database:migrate](#swdatabasemigrate)
* [sw:plugin:refresh](#swpluginrefresh)
* [sw:plugin:activate:all](#swpluginactivateall)
* [sw:plugin:migrate:all](#swpluginmigrateall)
* [sw:plugin:upgrade:all](#swpluginupgradeall)
* [sw:deploy](#swdeploy)
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### repository
[Source](https://github.com/deployphp/deployer/search?q=%22repository%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
* Overrides [`repository`](/docs/recipe/common.md#repository) from `recipe/common.php`
* Overrides [repository](/docs/recipe/common.md#repository) from `recipe/common.php`
```php title="Default value"
'git@github.com:shopware/production.git'
```
### release_name
[Source](https://github.com/deployphp/deployer/search?q=%22release_name%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
* Overrides [`release_name`](/docs/recipe/deploy/release.md#release_name) from `recipe/deploy/release.php`
* Overrides [release_name](/docs/recipe/deploy/release.md#release_name) from `recipe/deploy/release.php`
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
@ -75,79 +88,94 @@
## Tasks
### sw:update_code
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Aupdate_code%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:system:install
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Asystem%3Ainstall%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:build
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Abuild%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:system:setup
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Asystem%3Asetup%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:theme:compile
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Atheme%3Acompile%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:cache:clear
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Acache%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:cache:warmup
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Acache%3Awarmup%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:database:migrate
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Adatabase%3Amigrate%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:plugin:refresh
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Aplugin%3Arefresh%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:plugin:activate:all
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Aplugin%3Aactivate%3Aall%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:plugin:migrate:all
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Aplugin%3Amigrate%3Aall%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:plugin:upgrade:all
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Aplugin%3Aupgrade%3Aall%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
### sw:deploy
[Source](https://github.com/deployphp/deployer/search?q=%22sw%3Adeploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ashopware.php)
Grouped SW deploy tasks
This task is group task which contains next tasks:
* [`sw:plugin:activate:all`](/docs/recipe/shopware.md#swpluginactivateall)
* [`sw:database:migrate`](/docs/recipe/shopware.md#swdatabasemigrate)
* [`sw:plugin:migrate:all`](/docs/recipe/shopware.md#swpluginmigrateall)
* [`sw:build`](/docs/recipe/shopware.md#swbuild)
* [`sw:theme:compile`](/docs/recipe/shopware.md#swthemecompile)
* [`sw:cache:clear`](/docs/recipe/shopware.md#swcacheclear)
* [sw:plugin:activate:all](/docs/recipe/shopware.md#swpluginactivateall)
* [sw:database:migrate](/docs/recipe/shopware.md#swdatabasemigrate)
* [sw:plugin:migrate:all](/docs/recipe/shopware.md#swpluginmigrateall)
* [sw:build](/docs/recipe/shopware.md#swbuild)
* [sw:theme:compile](/docs/recipe/shopware.md#swthemecompile)
* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear)
### deploy
@ -155,11 +183,12 @@ This task is group task which contains next tasks:
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`sw:deploy`](/docs/recipe/shopware.md#swdeploy)
* [`deploy:clear_paths`](/docs/recipe/deploy/clear_paths.md#deployclear_paths)
* [`sw:cache:warmup`](/docs/recipe/shopware.md#swcachewarmup)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [sw:deploy](/docs/recipe/shopware.md#swdeploy)
* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deployclear_paths)
* [sw:cache:warmup](/docs/recipe/shopware.md#swcachewarmup)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

43
docs/recipe/silverstripe.md
View File

@ -9,63 +9,74 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_assets`](#shared_assets)
* [`shared_dirs`](#shared_dirs)
* [`writable_dirs`](#writable_dirs)
* [`silverstripe_cli_script`](#silverstripe_cli_script)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_assets](#shared_assets)
* [shared_dirs](#shared_dirs)
* [writable_dirs](#writable_dirs)
* [silverstripe_cli_script](#silverstripe_cli_script)
* Tasks
* [`silverstripe:build`](#silverstripebuild) — Run /dev/build
* [`silverstripe:buildflush`](#silverstripebuildflush) — Run /dev/build?flush=all
* [`deploy`](#deploy) — Deploy your project
* [silverstripe:build](#silverstripebuild) — Run /dev/build
* [silverstripe:buildflush](#silverstripebuildflush) — Run /dev/build?flush=all
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_assets
[Source](https://github.com/deployphp/deployer/search?q=%22shared_assets%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asilverstripe.php)
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asilverstripe.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
Silverstripe shared dirs
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asilverstripe.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
Silverstripe writable dirs
### silverstripe_cli_script
[Source](https://github.com/deployphp/deployer/search?q=%22silverstripe_cli_script%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asilverstripe.php)
Silverstripe cli script
## Tasks
### silverstripe:build
[Source](https://github.com/deployphp/deployer/search?q=%22silverstripe%3Abuild%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asilverstripe.php)
Helper tasks
### silverstripe:buildflush
[Source](https://github.com/deployphp/deployer/search?q=%22silverstripe%3Abuildflush%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asilverstripe.php)
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asilverstripe.php)
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`silverstripe:buildflush`](/docs/recipe/silverstripe.md#silverstripebuildflush)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [silverstripe:buildflush](/docs/recipe/silverstripe.md#silverstripebuildflush)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

78
docs/recipe/statamic.md
View File

@ -9,134 +9,154 @@
* Require
* [`recipe/laravel.php`](/docs/recipe/laravel.md)
* Config
* [`statamic_version`](#statamic_version)
* [laravel](/docs/recipe/laravel.md)
* Configuration
* [statamic_version](#statamic_version)
* Tasks
* [`statamic:addons:discover`](#statamicaddonsdiscover) — Rebuild the cached addon package manifest
* [`statamic:assets:generate-presets`](#statamicassetsgenerate-presets) — Generate asset preset manipulations
* [`statamic:assets:meta`](#statamicassetsmeta) — Generate asset metadata files
* [`statamic:git:commit`](#statamicgitcommit) — Git add and commit tracked content
* [`statamic:glide:clear`](#statamicglideclear) — Clear the Glide image cache
* [`statamic:responsive:generate`](#statamicresponsivegenerate) — Generate responsive images
* [`statamic:responsive:regenerate`](#statamicresponsiveregenerate) — Regenerate responsive images
* [`statamic:search:insert`](#statamicsearchinsert) — Insert an item into its search indexes
* [`statamic:search:update`](#statamicsearchupdate) — Update a search index
* [`statamic:stache:clear`](#statamicstacheclear) — Clear the "Stache" cache
* [`statamic:stache:doctor`](#statamicstachedoctor) — Diagnose any problems with the Stache
* [`statamic:stache:refresh`](#statamicstacherefresh) — Clear and rebuild the "Stache" cache
* [`statamic:stache:warm`](#statamicstachewarm) — Build the "Stache" cache
* [`statamic:static:clear`](#statamicstaticclear) — Clear the static page cache
* [`statamic:static:warm`](#statamicstaticwarm) — Warms the static cache by visiting all URLs
* [`statamic:support:details`](#statamicsupportdetails) — Outputs details helpful for support requests
* [`statamic:updates:run`](#statamicupdatesrun) — Run update scripts from specific version
* [`deploy`](#deploy) — Deploy your project
* [statamic:addons:discover](#statamicaddonsdiscover) — Rebuild the cached addon package manifest
* [statamic:assets:generate-presets](#statamicassetsgenerate-presets) — Generate asset preset manipulations
* [statamic:assets:meta](#statamicassetsmeta) — Generate asset metadata files
* [statamic:git:commit](#statamicgitcommit) — Git add and commit tracked content
* [statamic:glide:clear](#statamicglideclear) — Clear the Glide image cache
* [statamic:responsive:generate](#statamicresponsivegenerate) — Generate responsive images
* [statamic:responsive:regenerate](#statamicresponsiveregenerate) — Regenerate responsive images
* [statamic:search:insert](#statamicsearchinsert) — Insert an item into its search indexes
* [statamic:search:update](#statamicsearchupdate) — Update a search index
* [statamic:stache:clear](#statamicstacheclear) — Clear the "Stache" cache
* [statamic:stache:doctor](#statamicstachedoctor) — Diagnose any problems with the Stache
* [statamic:stache:refresh](#statamicstacherefresh) — Clear and rebuild the "Stache" cache
* [statamic:stache:warm](#statamicstachewarm) — Build the "Stache" cache
* [statamic:static:clear](#statamicstaticclear) — Clear the static page cache
* [statamic:static:warm](#statamicstaticwarm) — Warms the static cache by visiting all URLs
* [statamic:support:details](#statamicsupportdetails) — Outputs details helpful for support requests
* [statamic:updates:run](#statamicupdatesrun) — Run update scripts from specific version
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### statamic_version
[Source](https://github.com/deployphp/deployer/search?q=%22statamic_version%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
## Tasks
### statamic:addons:discover
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Aaddons%3Adiscover%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:assets:generate-presets
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Aassets%3Agenerate-presets%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:assets:meta
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Aassets%3Ameta%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:git:commit
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Agit%3Acommit%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:glide:clear
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Aglide%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:responsive:generate
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Aresponsive%3Agenerate%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:responsive:regenerate
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Aresponsive%3Aregenerate%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:search:insert
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Asearch%3Ainsert%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:search:update
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Asearch%3Aupdate%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:stache:clear
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Astache%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:stache:doctor
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Astache%3Adoctor%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:stache:refresh
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Astache%3Arefresh%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:stache:warm
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Astache%3Awarm%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:static:clear
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Astatic%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:static:warm
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Astatic%3Awarm%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:support:details
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Asupport%3Adetails%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### statamic:updates:run
[Source](https://github.com/deployphp/deployer/search?q=%22statamic%3Aupdates%3Arun%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Astatamic.php)
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`artisan:storage:link`](/docs/recipe/laravel.md#artisanstoragelink)
* [`artisan:cache:clear`](/docs/recipe/laravel.md#artisancacheclear)
* [`statamic:stache:clear`](/docs/recipe/statamic.md#statamicstacheclear)
* [`statamic:stache:warm`](/docs/recipe/statamic.md#statamicstachewarm)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [artisan:storage:link](/docs/recipe/laravel.md#artisanstoragelink)
* [artisan:cache:clear](/docs/recipe/laravel.md#artisancacheclear)
* [statamic:stache:clear](/docs/recipe/statamic.md#statamicstacheclear)
* [statamic:stache:warm](/docs/recipe/statamic.md#statamicstachewarm)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

11
docs/recipe/sulu.md
View File

@ -9,11 +9,11 @@
* Require
* [`recipe/symfony.php`](/docs/recipe/symfony.md)
* [symfony](/docs/recipe/symfony.md)
* Tasks
* [`phpcr:migrate`](#phpcrmigrate) — Migrate PHPCR
* [`deploy:website:cache:clear`](#deploywebsitecacheclear) — Clear cache
* [`deploy:website:cache:warmup`](#deploywebsitecachewarmup) — Warm up cache
* [phpcr:migrate](#phpcrmigrate) — Migrate PHPCR
* [deploy:website:cache:clear](#deploywebsitecacheclear) — Clear cache
* [deploy:website:cache:warmup](#deploywebsitecachewarmup) — Warm up cache
## Tasks
@ -22,13 +22,16 @@
### deploy:website:cache:clear
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Awebsite%3Acache%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asulu.php)
### deploy:website:cache:warmup
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Awebsite%3Acache%3Awarmup%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asulu.php)

53
docs/recipe/symfony.md
View File

@ -9,43 +9,51 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`symfony_version`](#symfony_version)
* [`shared_dirs`](#shared_dirs)
* [`shared_files`](#shared_files)
* [`writable_dirs`](#writable_dirs)
* [`migrations_config`](#migrations_config)
* [`console_options`](#console_options)
* [common](/docs/recipe/common.md)
* Configuration
* [symfony_version](#symfony_version)
* [shared_dirs](#shared_dirs)
* [shared_files](#shared_files)
* [writable_dirs](#writable_dirs)
* [migrations_config](#migrations_config)
* [console_options](#console_options)
* Tasks
* [`database:migrate`](#databasemigrate) — Migrate database
* [`deploy:cache:clear`](#deploycacheclear) — Clear cache
* [`deploy`](#deploy) — Deploy project
* [database:migrate](#databasemigrate) — Migrate database
* [deploy:cache:clear](#deploycacheclear) — Clear cache
* [deploy](#deploy) — Deploy project
## Config
## Configuration
### symfony_version
[Source](https://github.com/deployphp/deployer/search?q=%22symfony_version%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asymfony.php)
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asymfony.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asymfony.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asymfony.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
@ -54,32 +62,39 @@
### console_options
[Source](https://github.com/deployphp/deployer/search?q=%22console_options%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asymfony.php)
## Tasks
### database:migrate
[Source](https://github.com/deployphp/deployer/search?q=%22database%3Amigrate%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asymfony.php)
### deploy:cache:clear
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%3Acache%3Aclear%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asymfony.php)
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Asymfony.php)
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:cache:clear`](/docs/recipe/symfony.md#deploycacheclear)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:cache:clear](/docs/recipe/symfony.md#deploycacheclear)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

40
docs/recipe/typo3.md
View File

@ -9,52 +9,64 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`typo3_webroot`](#typo3_webroot)
* [`shared_dirs`](#shared_dirs)
* [`shared_files`](#shared_files)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [typo3_webroot](#typo3_webroot)
* [shared_dirs](#shared_dirs)
* [shared_files](#shared_files)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### typo3_webroot
[Source](https://github.com/deployphp/deployer/search?q=%22typo3_webroot%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Atypo3.php)
DocumentRoot / WebRoot for the TYPO3 installation
```php title="Default value"
'Web'
```
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Atypo3.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
Shared directories
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Atypo3.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
Shared files
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Atypo3.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
Writeable directories
## Tasks
### deploy
[Source](https://github.com/deployphp/deployer/search?q=%22deploy%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Atypo3.php)
Main TYPO3 task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

40
docs/recipe/wordpress.md
View File

@ -9,36 +9,51 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_files`](#shared_files)
* [`shared_dirs`](#shared_dirs)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_files](#shared_files)
* [shared_dirs](#shared_dirs)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_files
[Source](https://github.com/deployphp/deployer/search?q=%22shared_files%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Awordpress.php)
* Overrides [`shared_files`](/docs/recipe/common.md#shared_files) from `recipe/common.php`
* Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`
```php title="Default value"
['wp-config.php']
```
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Awordpress.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
```php title="Default value"
['wp-content/uploads']
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Awordpress.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
```php title="Default value"
['wp-content/uploads']
```
## Tasks
### deploy
@ -46,8 +61,9 @@
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

33
docs/recipe/yii.md
View File

@ -9,28 +9,38 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* Config
* [`shared_dirs`](#shared_dirs)
* [`writable_dirs`](#writable_dirs)
* [common](/docs/recipe/common.md)
* Configuration
* [shared_dirs](#shared_dirs)
* [writable_dirs](#writable_dirs)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Config
## Configuration
### shared_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22shared_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ayii.php)
* Overrides [`shared_dirs`](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
* Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`
Yii shared dirs
```php title="Default value"
['runtime']
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/search?q=%22writable_dirs%22+in%3Afile+language%3Aphp+path%3Arecipe+filename%3Ayii.php)
* Overrides [`writable_dirs`](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
* Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`
Yii writable dirs
```php title="Default value"
['runtime']
```
## Tasks
### deploy
@ -38,9 +48,10 @@ Yii writable dirs
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

11
docs/recipe/zend_framework.md
View File

@ -9,9 +9,9 @@
* Require
* [`recipe/common.php`](/docs/recipe/common.md)
* [common](/docs/recipe/common.md)
* Tasks
* [`deploy`](#deploy) — Deploy your project
* [deploy](#deploy) — Deploy your project
## Tasks
@ -20,9 +20,10 @@
Main task
This task is group task which contains next tasks:
* [`deploy:prepare`](/docs/recipe/common.md#deployprepare)
* [`deploy:vendors`](/docs/recipe/deploy/vendors.md#deployvendors)
* [`deploy:publish`](/docs/recipe/common.md#deploypublish)
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [deploy:publish](/docs/recipe/common.md#deploypublish)

3
recipe/common.php
View File

@ -81,7 +81,8 @@ set('use_atomic_symlink', function () {
return commandSupportsOption('mv', '--no-target-directory');
});
// Default timeout for `run()` and `runLocally()` functions. Default to 300 seconds.
// Default timeout for `run()` and `runLocally()` functions.
//
// Set to `null` to disable timeout.
set('default_timeout', 300);

3
src/Documentation/ApiGen.php
View File

@ -73,7 +73,8 @@ MD;
foreach ($this->fns as $fn) {
['funcName' => $funcName] = $fn;
$output .= " * [`$funcName()`](#$funcName)\n";
$anchor = strtolower($funcName);
$output .= " * [`$funcName()`](#$anchor)\n";
}
$output .= "\n";

1
src/Documentation/DocConfig.php
View File

@ -11,6 +11,7 @@ namespace Deployer\Documentation;
class DocConfig
{
public $name;
public $defaultValue;
public $comment;
public $recipePath;
public $lineNumber;

70
src/Documentation/DocGen.php
View File

File diff suppressed because one or more lines are too long

9
src/Documentation/DocRecipe.php
View File

@ -53,11 +53,11 @@ class DocRecipe
case 'root':
if ($match('^/\*\*?')) {
$state = 'comment';
$comment .= trimComment($line) . "\n";
$comment .= trim_comment($line) . "\n";
break;
}
if ($match('^//')) {
$comment .= trimComment($line) . "\n";
$comment .= trim_comment($line) . "\n";
break;
}
if ($match('^require.+?[\'"](?<recipe>.+?)[\'"]')) {
@ -71,6 +71,9 @@ class DocRecipe
$comment = '';
$set->recipePath = $this->recipePath;
$set->lineNumber = $i + 1;
if (preg_match('#^set\(.+?,\s(?<value>.+?)\);$#', $line, $m)) {
$set->defaultValue = $m['value'];
}
$this->config[$set->name] = $set;
break;
}
@ -120,7 +123,7 @@ class DocRecipe
$state = 'root';
break;
}
$comment .= trimComment($line) . "\n";
$comment .= trim_comment($line) . "\n";
break;
case 'group_task':