diff --git a/docs/contrib/bugsnag.md b/docs/contrib/bugsnag.md index 901dad95c..da9c61af7 100644 --- a/docs/contrib/bugsnag.md +++ b/docs/contrib/bugsnag.md @@ -26,7 +26,7 @@ after('deploy', 'bugsnag:notify'); ## Tasks -### bugsnag:notify +### bugsnag:notify {#bugsnag-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/bugsnag.php#L24) Notifies Bugsnag of deployment. diff --git a/docs/contrib/cachetool.md b/docs/contrib/cachetool.md index e87461699..b1da3d9b5 100644 --- a/docs/contrib/cachetool.md +++ b/docs/contrib/cachetool.md @@ -133,7 +133,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### cachetool:clear:opcache +### cachetool:clear:opcache {#cachetool-clear-opcache} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L89) Clears OPcode cache. @@ -141,7 +141,7 @@ Clears OPcode cache. Clear opcache cache -### cachetool:clear:apcu +### cachetool:clear:apcu {#cachetool-clear-apcu} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L100) Clears APCu system cache. @@ -149,7 +149,7 @@ Clears APCu system cache. Clear APCu cache -### cachetool:clear:stat +### cachetool:clear:stat {#cachetool-clear-stat} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cachetool.php#L111) Clears file status and realpath caches. diff --git a/docs/contrib/chatwork.md b/docs/contrib/chatwork.md index 8bcefed84..237935c08 100644 --- a/docs/contrib/chatwork.md +++ b/docs/contrib/chatwork.md @@ -148,7 +148,7 @@ The Messages ## Tasks -### chatwork_send_message +### chatwork_send_message {#chatwork_send_message} [Source](https://github.com/deployphp/deployer/blob/master/contrib/chatwork.php#L109) @@ -156,7 +156,7 @@ The Messages Helpers -### chatwork:test +### chatwork:test {#chatwork-test} [Source](https://github.com/deployphp/deployer/blob/master/contrib/chatwork.php#L118) Tests messages. @@ -164,7 +164,7 @@ Tests messages. Tasks -### chatwork:notify +### chatwork:notify {#chatwork-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/chatwork.php#L129) Notifies Chatwork. @@ -172,7 +172,7 @@ Notifies Chatwork. -### chatwork:notify:success +### chatwork:notify:success {#chatwork-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/chatwork.php#L144) Notifies Chatwork about deploy finish. @@ -180,7 +180,7 @@ Notifies Chatwork about deploy finish. -### chatwork:notify:failure +### chatwork:notify:failure {#chatwork-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/chatwork.php#L160) Notifies Chatwork about deploy failure. diff --git a/docs/contrib/cimonitor.md b/docs/contrib/cimonitor.md index cfaf3eb0f..945abd33a 100644 --- a/docs/contrib/cimonitor.md +++ b/docs/contrib/cimonitor.md @@ -183,7 +183,7 @@ get('cimonitor_status_success') ## Tasks -### cimonitor:notify +### cimonitor:notify {#cimonitor-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cimonitor.php#L89) Notifies CIMonitor. @@ -191,7 +191,7 @@ Notifies CIMonitor. -### cimonitor:notify:success +### cimonitor:notify:success {#cimonitor-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cimonitor.php#L115) Notifies CIMonitor about deploy finish. @@ -199,7 +199,7 @@ Notifies CIMonitor about deploy finish. -### cimonitor:notify:failure +### cimonitor:notify:failure {#cimonitor-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cimonitor.php#L143) Notifies CIMonitor about deploy failure. diff --git a/docs/contrib/cloudflare.md b/docs/contrib/cloudflare.md index e9b2b1404..f1116666f 100644 --- a/docs/contrib/cloudflare.md +++ b/docs/contrib/cloudflare.md @@ -28,7 +28,7 @@ if not the, last tasks before cleanup ## Tasks -### deploy:cloudflare +### deploy:cloudflare {#deploy-cloudflare} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cloudflare.php#L24) Clears Cloudflare Cache. diff --git a/docs/contrib/cpanel.md b/docs/contrib/cpanel.md index 8a59d7318..0dc681a9f 100644 --- a/docs/contrib/cpanel.md +++ b/docs/contrib/cpanel.md @@ -115,7 +115,7 @@ after('deploy:prepare', 'cpanel:createdb'); ## Tasks -### cpanel:createdb +### cpanel:createdb {#cpanel-createdb} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cpanel.php#L196) Creates database though CPanel API. @@ -123,7 +123,7 @@ Creates database though CPanel API. -### cpanel:createaddondomain +### cpanel:createaddondomain {#cpanel-createaddondomain} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cpanel.php#L224) Creates addon domain though CPanel API. @@ -131,7 +131,7 @@ Creates addon domain though CPanel API. -### cpanel:deleteaddondomain +### cpanel:deleteaddondomain {#cpanel-deleteaddondomain} [Source](https://github.com/deployphp/deployer/blob/master/contrib/cpanel.php#L247) Deletes addon domain though CPanel API. diff --git a/docs/contrib/crontab.md b/docs/contrib/crontab.md index f7395cf88..32f7a5d56 100644 --- a/docs/contrib/crontab.md +++ b/docs/contrib/crontab.md @@ -74,7 +74,7 @@ false ## Tasks -### crontab:sync +### crontab:sync {#crontab-sync} [Source](https://github.com/deployphp/deployer/blob/master/contrib/crontab.php#L41) Sync crontab jobs. diff --git a/docs/contrib/directadmin.md b/docs/contrib/directadmin.md index 21089cf24..5eb564964 100644 --- a/docs/contrib/directadmin.md +++ b/docs/contrib/directadmin.md @@ -32,7 +32,7 @@ require 'contrib/directadmin.php'; ## Tasks -### directadmin:createdb +### directadmin:createdb {#directadmin-createdb} [Source](https://github.com/deployphp/deployer/blob/master/contrib/directadmin.php#L76) Creates a database on DirectAdmin. @@ -40,7 +40,7 @@ Creates a database on DirectAdmin. -### directadmin:deletedb +### directadmin:deletedb {#directadmin-deletedb} [Source](https://github.com/deployphp/deployer/blob/master/contrib/directadmin.php#L96) Deletes a database on DirectAdmin. @@ -48,7 +48,7 @@ Deletes a database on DirectAdmin. -### directadmin:createdomain +### directadmin:createdomain {#directadmin-createdomain} [Source](https://github.com/deployphp/deployer/blob/master/contrib/directadmin.php#L111) Creates a domain on DirectAdmin. @@ -56,7 +56,7 @@ Creates a domain on DirectAdmin. -### directadmin:deletedomain +### directadmin:deletedomain {#directadmin-deletedomain} [Source](https://github.com/deployphp/deployer/blob/master/contrib/directadmin.php#L129) Deletes a domain on DirectAdmin. @@ -64,7 +64,7 @@ Deletes a domain on DirectAdmin. -### directadmin:symlink-private-html +### directadmin:symlink-private-html {#directadmin-symlink-private-html} [Source](https://github.com/deployphp/deployer/blob/master/contrib/directadmin.php#L145) Symlink your private_html to public_html. @@ -72,7 +72,7 @@ Symlink your private_html to public_html. -### directadmin:php-version +### directadmin:php-version {#directadmin-php-version} [Source](https://github.com/deployphp/deployer/blob/master/contrib/directadmin.php#L161) Changes the PHP version from a domain. diff --git a/docs/contrib/discord.md b/docs/contrib/discord.md index 197c5da37..c4e50ffa9 100644 --- a/docs/contrib/discord.md +++ b/docs/contrib/discord.md @@ -106,7 +106,7 @@ The message ## Tasks -### discord_send_message +### discord_send_message {#discord_send_message} [Source](https://github.com/deployphp/deployer/blob/master/contrib/discord.php#L79) @@ -114,7 +114,7 @@ The message Helpers -### discord:test +### discord:test {#discord-test} [Source](https://github.com/deployphp/deployer/blob/master/contrib/discord.php#L87) Tests messages. @@ -122,7 +122,7 @@ Tests messages. Tasks -### discord:notify +### discord:notify {#discord-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/discord.php#L98) Notifies Discord. @@ -130,7 +130,7 @@ Notifies Discord. -### discord:notify:success +### discord:notify:success {#discord-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/discord.php#L106) Notifies Discord about deploy finish. @@ -138,7 +138,7 @@ Notifies Discord about deploy finish. -### discord:notify:failure +### discord:notify:failure {#discord-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/discord.php#L114) Notifies Discord about deploy failure. diff --git a/docs/contrib/grafana.md b/docs/contrib/grafana.md index d79b6147c..eb4523aab 100644 --- a/docs/contrib/grafana.md +++ b/docs/contrib/grafana.md @@ -36,7 +36,7 @@ after('deploy:success', 'grafana:annotation'); ## Tasks -### grafana:annotation +### grafana:annotation {#grafana-annotation} [Source](https://github.com/deployphp/deployer/blob/master/contrib/grafana.php#L38) Creates Grafana annotation of deployment. diff --git a/docs/contrib/hangouts.md b/docs/contrib/hangouts.md index 64f0ee6ca..771a5a21a 100644 --- a/docs/contrib/hangouts.md +++ b/docs/contrib/hangouts.md @@ -92,7 +92,7 @@ Deploy messages ## Tasks -### chat:notify +### chat:notify {#chat-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/hangouts.php#L60) Notifies Google Hangouts Chat. @@ -100,7 +100,7 @@ Notifies Google Hangouts Chat. -### chat:notify:success +### chat:notify:success {#chat-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/hangouts.php#L102) Notifies Google Hangouts Chat about deploy finish. @@ -108,7 +108,7 @@ Notifies Google Hangouts Chat about deploy finish. -### chat:notify:failure +### chat:notify:failure {#chat-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/hangouts.php#L144) Notifies Google Hangouts Chat about deploy failure. diff --git a/docs/contrib/hipchat.md b/docs/contrib/hipchat.md index 1d7b88dba..8ae986284 100644 --- a/docs/contrib/hipchat.md +++ b/docs/contrib/hipchat.md @@ -70,7 +70,7 @@ after('deploy', 'hipchat:notify'); ## Tasks -### hipchat:notify +### hipchat:notify {#hipchat-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/hipchat.php#L32) Notifies Hipchat channel of deployment. diff --git a/docs/contrib/ispmanager.md b/docs/contrib/ispmanager.md index 00cfe80df..dbffefa37 100644 --- a/docs/contrib/ispmanager.md +++ b/docs/contrib/ispmanager.md @@ -131,7 +131,7 @@ Storage ## Tasks -### ispmanager:init +### ispmanager:init {#ispmanager-init} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L63) Installs ispmanager. @@ -139,7 +139,7 @@ Installs ispmanager. -### ispmanager:db-server-list +### ispmanager:db-server-list {#ispmanager-db-server-list} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L86) Takes database servers list. @@ -147,7 +147,7 @@ Takes database servers list. -### ispmanager:db-list +### ispmanager:db-list {#ispmanager-db-list} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L123) Takes databases list. @@ -155,7 +155,7 @@ Takes databases list. -### ispmanager:domain-list +### ispmanager:domain-list {#ispmanager-domain-list} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L145) Takes domain list. @@ -163,7 +163,7 @@ Takes domain list. -### ispmanager:db-create +### ispmanager:db-create {#ispmanager-db-create} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L161) Creates new database. @@ -171,7 +171,7 @@ Creates new database. -### ispmanager:db-delete +### ispmanager:db-delete {#ispmanager-db-delete} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L231) Deletes database. @@ -179,7 +179,7 @@ Deletes database. -### ispmanager:domain-create +### ispmanager:domain-create {#ispmanager-domain-create} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L282) Creates new domain. @@ -187,7 +187,7 @@ Creates new domain. -### ispmanager:get-php-list +### ispmanager:get-php-list {#ispmanager-get-php-list} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L328) Gets allowed PHP modes and versions. @@ -195,7 +195,7 @@ Gets allowed PHP modes and versions. -### ispmanager:print-php-list +### ispmanager:print-php-list {#ispmanager-print-php-list} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L374) Prints allowed PHP modes and versions. @@ -203,7 +203,7 @@ Prints allowed PHP modes and versions. -### ispmanager:domain-php-select +### ispmanager:domain-php-select {#ispmanager-domain-php-select} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L412) Switches PHP version for domain. @@ -211,7 +211,7 @@ Switches PHP version for domain. -### ispmanager:domain-alias-create +### ispmanager:domain-alias-create {#ispmanager-domain-alias-create} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L481) Creates new domain alias. @@ -219,7 +219,7 @@ Creates new domain alias. -### ispmanager:domain-alias-delete +### ispmanager:domain-alias-delete {#ispmanager-domain-alias-delete} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L550) Deletes domain alias. @@ -227,7 +227,7 @@ Deletes domain alias. -### ispmanager:domain-delete +### ispmanager:domain-delete {#ispmanager-domain-delete} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L618) Deletes domain. @@ -235,7 +235,7 @@ Deletes domain. -### ispmanager:process +### ispmanager:process {#ispmanager-process} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ispmanager.php#L665) Auto task processing. diff --git a/docs/contrib/mattermost.md b/docs/contrib/mattermost.md index 8e3cea31f..273244ae9 100644 --- a/docs/contrib/mattermost.md +++ b/docs/contrib/mattermost.md @@ -159,7 +159,7 @@ null ## Tasks -### mattermost:notify +### mattermost:notify {#mattermost-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/mattermost.php#L94) Notifies mattermost. @@ -167,7 +167,7 @@ Notifies mattermost. -### mattermost:notify:success +### mattermost:notify:success {#mattermost-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/mattermost.php#L115) Notifies mattermost about deploy finish. @@ -175,7 +175,7 @@ Notifies mattermost about deploy finish. -### mattermost:notify:failure +### mattermost:notify:failure {#mattermost-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/mattermost.php#L136) Notifies mattermost about deploy failure. diff --git a/docs/contrib/ms-teams.md b/docs/contrib/ms-teams.md index 79fba0277..cb5ca81f5 100644 --- a/docs/contrib/ms-teams.md +++ b/docs/contrib/ms-teams.md @@ -145,7 +145,7 @@ Color of attachment ## Tasks -### teams:notify +### teams:notify {#teams-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L94) Notifies Teams. @@ -153,7 +153,7 @@ Notifies Teams. -### teams:notify:success +### teams:notify:success {#teams-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L109) Notifies Teams about deploy finish. @@ -161,7 +161,7 @@ Notifies Teams about deploy finish. -### teams:notify:failure +### teams:notify:failure {#teams-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L124) Notifies Teams about deploy failure. diff --git a/docs/contrib/newrelic.md b/docs/contrib/newrelic.md index c0859584b..8f6d5012f 100644 --- a/docs/contrib/newrelic.md +++ b/docs/contrib/newrelic.md @@ -69,7 +69,7 @@ return runLocally('git log -n 1 --format="%h"'); ## Tasks -### newrelic:notify +### newrelic:notify {#newrelic-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/newrelic.php#L39) Notifies New Relic of deployment. diff --git a/docs/contrib/npm.md b/docs/contrib/npm.md index 5b5425143..3ca892ee0 100644 --- a/docs/contrib/npm.md +++ b/docs/contrib/npm.md @@ -39,7 +39,7 @@ return which('npm'); ## Tasks -### npm:install +### npm:install {#npm-install} [Source](https://github.com/deployphp/deployer/blob/master/contrib/npm.php#L27) Installs npm packages. diff --git a/docs/contrib/ntfy.md b/docs/contrib/ntfy.md index 7da89e92f..88bc5d4b6 100644 --- a/docs/contrib/ntfy.md +++ b/docs/contrib/ntfy.md @@ -158,7 +158,7 @@ Message tags ## Tasks -### ntfy:notify +### ntfy:notify {#ntfy-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ntfy.php#L108) Notifies ntfy server. @@ -166,7 +166,7 @@ Notifies ntfy server. -### ntfy:notify:success +### ntfy:notify:success {#ntfy-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ntfy.php#L126) Notifies ntfy server about deploy finish. @@ -174,7 +174,7 @@ Notifies ntfy server about deploy finish. -### ntfy:notify:failure +### ntfy:notify:failure {#ntfy-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/ntfy.php#L144) Notifies ntfy server about deploy failure. diff --git a/docs/contrib/phinx.md b/docs/contrib/phinx.md index aa2a16d4e..6877636c8 100644 --- a/docs/contrib/phinx.md +++ b/docs/contrib/phinx.md @@ -80,7 +80,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### phinx:migrate +### phinx:migrate {#phinx-migrate} [Source](https://github.com/deployphp/deployer/blob/master/contrib/phinx.php#L149) Migrats database with phinx. @@ -88,7 +88,7 @@ Migrats database with phinx. -### phinx:rollback +### phinx:rollback {#phinx-rollback} [Source](https://github.com/deployphp/deployer/blob/master/contrib/phinx.php#L170) Rollbacks database migrations with phinx. @@ -96,7 +96,7 @@ Rollbacks database migrations with phinx. -### phinx:seed +### phinx:seed {#phinx-seed} [Source](https://github.com/deployphp/deployer/blob/master/contrib/phinx.php#L191) Seeds database with phinx. @@ -104,7 +104,7 @@ Seeds database with phinx. -### phinx:breakpoint +### phinx:breakpoint {#phinx-breakpoint} [Source](https://github.com/deployphp/deployer/blob/master/contrib/phinx.php#L211) Sets a migrations breakpoint with phinx. diff --git a/docs/contrib/php-fpm.md b/docs/contrib/php-fpm.md index 50367c5ee..1f7c4c760 100644 --- a/docs/contrib/php-fpm.md +++ b/docs/contrib/php-fpm.md @@ -74,7 +74,7 @@ return run('{{bin/php}} -r "printf(\'%d.%d\', PHP_MAJOR_VERSION, PHP_MINOR_VERSI ## Tasks -### php-fpm:reload +### php-fpm:reload {#php-fpm-reload} [Source](https://github.com/deployphp/deployer/blob/master/contrib/php-fpm.php#L42) Reloads the php-fpm service. diff --git a/docs/contrib/rabbit.md b/docs/contrib/rabbit.md index da83225f1..44d4b3c49 100644 --- a/docs/contrib/rabbit.md +++ b/docs/contrib/rabbit.md @@ -49,7 +49,7 @@ before('deploy:end', 'deploy:rabbit'); ## Tasks -### deploy:rabbit +### deploy:rabbit {#deploy-rabbit} [Source](https://github.com/deployphp/deployer/blob/master/contrib/rabbit.php#L58) Notifies RabbitMQ channel about deployment. diff --git a/docs/contrib/raygun.md b/docs/contrib/raygun.md index 20f571a3a..363c42660 100644 --- a/docs/contrib/raygun.md +++ b/docs/contrib/raygun.md @@ -30,7 +30,7 @@ after('deploy', 'raygun:notify'); ## Tasks -### raygun:notify +### raygun:notify {#raygun-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/raygun.php#L28) Notifies Raygun of deployment. diff --git a/docs/contrib/rocketchat.md b/docs/contrib/rocketchat.md index a9ff12e22..26d1947b2 100644 --- a/docs/contrib/rocketchat.md +++ b/docs/contrib/rocketchat.md @@ -188,7 +188,7 @@ null ## Tasks -### rocketchat:notify +### rocketchat:notify {#rocketchat-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/rocketchat.php#L86) Notifies RocketChat. @@ -196,7 +196,7 @@ Notifies RocketChat. -### rocketchat:notify:success +### rocketchat:notify:success {#rocketchat-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/rocketchat.php#L116) Notifies RocketChat about deploy finish. @@ -204,7 +204,7 @@ Notifies RocketChat about deploy finish. -### rocketchat:notify:failure +### rocketchat:notify:failure {#rocketchat-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/rocketchat.php#L146) Notifies RocketChat about deploy failure. diff --git a/docs/contrib/rollbar.md b/docs/contrib/rollbar.md index 0959c506a..a872fb401 100644 --- a/docs/contrib/rollbar.md +++ b/docs/contrib/rollbar.md @@ -40,7 +40,7 @@ after('deploy', 'rollbar:notify'); ## Tasks -### rollbar:notify +### rollbar:notify {#rollbar-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/rollbar.php#L30) Notifies Rollbar of deployment. diff --git a/docs/contrib/rsync.md b/docs/contrib/rsync.md index 94d5c9b72..3a0ee1559 100644 --- a/docs/contrib/rsync.md +++ b/docs/contrib/rsync.md @@ -190,7 +190,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### rsync:warmup +### rsync:warmup {#rsync-warmup} [Source](https://github.com/deployphp/deployer/blob/master/contrib/rsync.php#L199) Warmups remote Rsync target. @@ -198,7 +198,7 @@ Warmups remote Rsync target. -### rsync +### rsync {#rsync} [Source](https://github.com/deployphp/deployer/blob/master/contrib/rsync.php#L214) Rsync local->remote. diff --git a/docs/contrib/slack.md b/docs/contrib/slack.md index 203617f55..e0eea9480 100644 --- a/docs/contrib/slack.md +++ b/docs/contrib/slack.md @@ -170,7 +170,7 @@ Color of attachment ## Tasks -### slack:notify +### slack:notify {#slack-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/slack.php#L100) Notifies Slack. @@ -178,7 +178,7 @@ Notifies Slack. -### slack:notify:success +### slack:notify:success {#slack-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/slack.php#L120) Notifies Slack about deploy finish. @@ -186,7 +186,7 @@ Notifies Slack about deploy finish. -### slack:notify:failure +### slack:notify:failure {#slack-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/slack.php#L141) Notifies Slack about deploy failure. @@ -194,7 +194,7 @@ Notifies Slack about deploy failure. -### slack:notify:rollback +### slack:notify:rollback {#slack-notify-rollback} [Source](https://github.com/deployphp/deployer/blob/master/contrib/slack.php#L161) Notifies Slack about rollback. diff --git a/docs/contrib/supervisord-monitor.md b/docs/contrib/supervisord-monitor.md index 42d7287da..6367cb9b3 100644 --- a/docs/contrib/supervisord-monitor.md +++ b/docs/contrib/supervisord-monitor.md @@ -80,7 +80,7 @@ task('supervisord', ['supervisord-monitor:restart']) ## Tasks -### supervisord-monitor:restart +### supervisord-monitor:restart {#supervisord-monitor-restart} [Source](https://github.com/deployphp/deployer/blob/master/contrib/supervisord-monitor.php#L134) @@ -88,7 +88,7 @@ task('supervisord', ['supervisord-monitor:restart']) -### supervisord-monitor:stop +### supervisord-monitor:stop {#supervisord-monitor-stop} [Source](https://github.com/deployphp/deployer/blob/master/contrib/supervisord-monitor.php#L151) @@ -96,7 +96,7 @@ task('supervisord', ['supervisord-monitor:restart']) -### supervisord-monitor:start +### supervisord-monitor:start {#supervisord-monitor-start} [Source](https://github.com/deployphp/deployer/blob/master/contrib/supervisord-monitor.php#L165) diff --git a/docs/contrib/telegram.md b/docs/contrib/telegram.md index 855da16d2..785b49182 100644 --- a/docs/contrib/telegram.md +++ b/docs/contrib/telegram.md @@ -131,7 +131,7 @@ Deploy message ## Tasks -### telegram:notify +### telegram:notify {#telegram-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/telegram.php#L87) Notifies Telegram. @@ -139,7 +139,7 @@ Notifies Telegram. -### telegram:notify:success +### telegram:notify:success {#telegram-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/telegram.php#L118) Notifies Telegram about deploy finish. @@ -147,7 +147,7 @@ Notifies Telegram about deploy finish. -### telegram:notify:failure +### telegram:notify:failure {#telegram-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/telegram.php#L149) Notifies Telegram about deploy failure. diff --git a/docs/contrib/webpack_encore.md b/docs/contrib/webpack_encore.md index bb80e69cb..d52554658 100644 --- a/docs/contrib/webpack_encore.md +++ b/docs/contrib/webpack_encore.md @@ -61,7 +61,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### webpack_encore:build +### webpack_encore:build {#webpack_encore-build} [Source](https://github.com/deployphp/deployer/blob/master/contrib/webpack_encore.php#L36) Runs webpack encore build. diff --git a/docs/contrib/workplace.md b/docs/contrib/workplace.md index 595e3e806..0cfdabb06 100644 --- a/docs/contrib/workplace.md +++ b/docs/contrib/workplace.md @@ -102,7 +102,7 @@ false ## Tasks -### workplace:notify +### workplace:notify {#workplace-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/workplace.php#L79) Notifies Workplace. @@ -110,7 +110,7 @@ Notifies Workplace. -### workplace:notify:success +### workplace:notify:success {#workplace-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/workplace.php#L103) Notifies Workplace about deploy finish. @@ -118,7 +118,7 @@ Notifies Workplace about deploy finish. -### workplace:notify:failure +### workplace:notify:failure {#workplace-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/workplace.php#L114) Notifies Workplace about deploy failure. diff --git a/docs/contrib/yammer.md b/docs/contrib/yammer.md index 74456a030..c28581f64 100644 --- a/docs/contrib/yammer.md +++ b/docs/contrib/yammer.md @@ -102,7 +102,7 @@ Deploy message ## Tasks -### yammer:notify +### yammer:notify {#yammer-notify} [Source](https://github.com/deployphp/deployer/blob/master/contrib/yammer.php#L68) Notifies Yammer. @@ -110,7 +110,7 @@ Notifies Yammer. -### yammer:notify:success +### yammer:notify:success {#yammer-notify-success} [Source](https://github.com/deployphp/deployer/blob/master/contrib/yammer.php#L87) Notifies Yammer about deploy finish. @@ -118,7 +118,7 @@ Notifies Yammer about deploy finish. -### yammer:notify:failure +### yammer:notify:failure {#yammer-notify-failure} [Source](https://github.com/deployphp/deployer/blob/master/contrib/yammer.php#L106) Notifies Yammer about deploy failure. diff --git a/docs/contrib/yarn.md b/docs/contrib/yarn.md index 5a188b3b5..2cc0c3b60 100644 --- a/docs/contrib/yarn.md +++ b/docs/contrib/yarn.md @@ -39,7 +39,7 @@ return which('yarn'); ## Tasks -### yarn:install +### yarn:install {#yarn-install} [Source](https://github.com/deployphp/deployer/blob/master/contrib/yarn.php#L22) Installs Yarn packages. diff --git a/docs/recipe/cakephp.md b/docs/recipe/cakephp.md index 9449cdd44..aa47c1283 100644 --- a/docs/recipe/cakephp.md +++ b/docs/recipe/cakephp.md @@ -28,23 +28,23 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Cakephp** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:init](/docs/recipe/cakephp.md#deployinit) – -* [deploy:run_migrations](/docs/recipe/cakephp.md#deployrun_migrations) – -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:init](/docs/recipe/cakephp.md#deploy-init) – +* [deploy:run_migrations](/docs/recipe/cakephp.md#deploy-run_migrations) – +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The cakephp recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -84,7 +84,7 @@ CakePHP 4 Project Template shared files ## Tasks -### deploy:init +### deploy:init {#deploy-init} [Source](https://github.com/deployphp/deployer/blob/master/recipe/cakephp.php#L28) @@ -92,7 +92,7 @@ CakePHP 4 Project Template shared files Create plugins' symlinks -### deploy:run_migrations +### deploy:run_migrations {#deploy-run_migrations} [Source](https://github.com/deployphp/deployer/blob/master/recipe/cakephp.php#L35) @@ -100,7 +100,7 @@ Create plugins' symlinks Run migrations -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/cakephp.php#L43) @@ -109,10 +109,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: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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:init](/docs/recipe/cakephp.md#deploy-init) +* [deploy:run_migrations](/docs/recipe/cakephp.md#deploy-run_migrations) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/codeigniter.md b/docs/recipe/codeigniter.md index 4dabb4511..3ad92aa50 100644 --- a/docs/recipe/codeigniter.md +++ b/docs/recipe/codeigniter.md @@ -28,21 +28,21 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Codeigniter** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The codeigniter recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -75,7 +75,7 @@ CodeIgniter writable dirs ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter.php#L19) Deploys your project. @@ -84,8 +84,8 @@ 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/codeigniter4.md b/docs/recipe/codeigniter4.md index d9c9febba..d21ebbf5b 100644 --- a/docs/recipe/codeigniter4.md +++ b/docs/recipe/codeigniter4.md @@ -28,23 +28,23 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Codeigniter 4** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [spark:optimize](/docs/recipe/codeigniter4.md#sparkoptimize) – Optimize for production. -* [spark:migrate](/docs/recipe/codeigniter4.md#sparkmigrate) – Locates and runs all new migrations against the database. -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [spark:optimize](/docs/recipe/codeigniter4.md#spark-optimize) – Optimize for production. +* [spark:migrate](/docs/recipe/codeigniter4.md#spark-migrate) – Locates and runs all new migrations against the database. +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The codeigniter4 recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -129,7 +129,7 @@ return $matches[0][0] ?? 5.5; ## Tasks -### spark:cache:info +### spark:cache:info {#spark-cache-info} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L94) Shows file cache information in the current system. @@ -137,7 +137,7 @@ Shows file cache information in the current system. Discover & Checks -### spark:config:check +### spark:config:check {#spark-config-check} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L97) Check your Config values. @@ -145,7 +145,7 @@ Check your Config values. -### spark:env +### spark:env {#spark-env} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L100) Retrieves the current environment, or set a new one. @@ -153,7 +153,7 @@ Retrieves the current environment, or set a new one. -### spark:filter:check +### spark:filter:check {#spark-filter-check} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L103) Check filters for a route. @@ -161,7 +161,7 @@ Check filters for a route. -### spark:lang:find +### spark:lang:find {#spark-lang-find} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L106) Find and save available phrases to translate. @@ -169,7 +169,7 @@ Find and save available phrases to translate. -### spark:namespaces +### spark:namespaces {#spark-namespaces} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L109) Verifies your namespaces are setup correctly. @@ -177,7 +177,7 @@ Verifies your namespaces are setup correctly. -### spark:phpini:check +### spark:phpini:check {#spark-phpini-check} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L112) Check your php.ini values. @@ -185,7 +185,7 @@ Check your php.ini values. -### spark:routes +### spark:routes {#spark-routes} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L115) Displays all routes. @@ -193,7 +193,7 @@ Displays all routes. -### spark:​key:generate +### spark:​key:generate {#spark-key-generate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L123) Generates a new encryption key and writes it in an `.env` file. @@ -201,7 +201,7 @@ Generates a new encryption key and writes it in an `.env` file. Actions -### spark:optimize +### spark:optimize {#spark-optimize} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L126) Optimize for production. @@ -209,7 +209,7 @@ Optimize for production. -### spark:publish +### spark:publish {#spark-publish} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L129) Discovers and executes all predefined Publisher classes. @@ -217,7 +217,7 @@ Discovers and executes all predefined Publisher classes. -### spark:db:create +### spark:db:create {#spark-db-create} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L137) Create a new database schema. @@ -225,7 +225,7 @@ Create a new database schema. Database and migrations. -### spark:db:seed +### spark:db:seed {#spark-db-seed} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L140) Runs the specified seeder to populate known data into the database. @@ -233,7 +233,7 @@ Runs the specified seeder to populate known data into the database. -### spark:db:table +### spark:db:table {#spark-db-table} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L143) Retrieves information on the selected table. @@ -241,7 +241,7 @@ Retrieves information on the selected table. -### spark:migrate +### spark:migrate {#spark-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L146) Locates and runs all new migrations against the database. @@ -249,7 +249,7 @@ Locates and runs all new migrations against the database. -### spark:migrate:refresh +### spark:migrate:refresh {#spark-migrate-refresh} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L149) Does a rollback followed by a latest to refresh the current state of the database. @@ -257,7 +257,7 @@ Does a rollback followed by a latest to refresh the current state of the databas -### spark:migrate:rollback +### spark:migrate:rollback {#spark-migrate-rollback} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L152) Runs the "down" method for all migrations in the last batch. @@ -265,7 +265,7 @@ Runs the "down" method for all migrations in the last batch. -### spark:migrate:status +### spark:migrate:status {#spark-migrate-status} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L155) Displays a list of all migrations and whether they\'ve been run or not. @@ -273,7 +273,7 @@ Displays a list of all migrations and whether they\'ve been run or not. -### spark:cache:clear +### spark:cache:clear {#spark-cache-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L163) Clears the current system caches. @@ -281,7 +281,7 @@ Clears the current system caches. Housekeeping -### spark:debugbar:clear +### spark:debugbar:clear {#spark-debugbar-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L166) Clears all debugbar JSON files. @@ -289,7 +289,7 @@ Clears all debugbar JSON files. -### spark:logs:clear +### spark:logs:clear {#spark-logs-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L169) Clears all log files. @@ -297,7 +297,7 @@ Clears all log files. -### spark:custom +### spark:custom {#spark-custom} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L176) Run a custom spark command. @@ -305,7 +305,7 @@ Run a custom spark command. Custom Spark Command for shield or setting packages -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/codeigniter4.php#L184) Deploys your project. @@ -314,10 +314,10 @@ 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) -* [spark:optimize](/docs/recipe/codeigniter4.md#sparkoptimize) -* [spark:migrate](/docs/recipe/codeigniter4.md#sparkmigrate) -* [deploy:publish](/docs/recipe/common.md#deploypublish) +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [spark:optimize](/docs/recipe/codeigniter4.md#spark-optimize) +* [spark:migrate](/docs/recipe/codeigniter4.md#spark-migrate) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/common.md b/docs/recipe/common.md index 4855723d2..f426a4b7f 100644 --- a/docs/recipe/common.md +++ b/docs/recipe/common.md @@ -193,7 +193,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### deploy:prepare +### deploy:prepare {#deploy-prepare} [Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L139) Prepares a new release. @@ -202,17 +202,17 @@ Prepares a new release. 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:env](/docs/recipe/deploy/env.md#deployenv) -* [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) -* [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) +* [deploy:info](/docs/recipe/deploy/info.md#deploy-info) +* [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) +* [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) +* [deploy:release](/docs/recipe/deploy/release.md#deploy-release) +* [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) +* [deploy:env](/docs/recipe/deploy/env.md#deploy-env) +* [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) +* [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) -### deploy:publish +### deploy:publish {#deploy-publish} [Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L151) Publishes the release. @@ -221,13 +221,13 @@ Publishes the release. 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#deploy-symlink) +* [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) +* [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) +* [deploy:success](/docs/recipe/common.md#deploy-success) -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L159) Deploys your project. @@ -236,11 +236,11 @@ Deploys your project. 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#deploy-prepare) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) -### deploy:success +### deploy:success {#deploy-success} [Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L168) Deploys your project. @@ -248,7 +248,7 @@ Deploys your project. Prints success message -### deploy:failed +### deploy:failed {#deploy-failed} [Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L177) @@ -256,7 +256,7 @@ Prints success message Hook on deploy failure. -### logs:app +### logs:app {#logs-app} [Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L186) Shows application logs. diff --git a/docs/recipe/composer.md b/docs/recipe/composer.md index ce20773f8..b3b0524cf 100644 --- a/docs/recipe/composer.md +++ b/docs/recipe/composer.md @@ -16,7 +16,7 @@ require 'recipe/composer.php'; ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/composer.php#L10) Deploys your project. @@ -25,8 +25,8 @@ Deploys your project. 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/contao.md b/docs/recipe/contao.md index 964553c04..e69bd490c 100644 --- a/docs/recipe/contao.md +++ b/docs/recipe/contao.md @@ -28,24 +28,24 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Contao** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [contao:maintenance:enable](/docs/recipe/contao.md#contaomaintenanceenable) – Enable maintenance mode -* [contao:migrate](/docs/recipe/contao.md#contaomigrate) – Run Contao migrations -* [contao:maintenance:disable](/docs/recipe/contao.md#contaomaintenancedisable) – Disable maintenance mode -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [contao:maintenance:enable](/docs/recipe/contao.md#contao-maintenance-enable) – Enable maintenance mode +* [contao:migrate](/docs/recipe/contao.md#contao-migrate) – Run Contao migrations +* [contao:maintenance:disable](/docs/recipe/contao.md#contao-maintenance-disable) – Disable maintenance mode +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The contao recipe is based on the [symfony](/docs/recipe/symfony.md) recipe. @@ -108,7 +108,7 @@ return $matches[0][0] ?? 5.0; ## Tasks -### contao:migrate +### contao:migrate {#contao-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/contao.php#L56) Run Contao migrations. @@ -124,7 +124,7 @@ task('contao:migrate', function () { ``` -### contao:manager:download +### contao:manager:download {#contao-manager-download} [Source](https://github.com/deployphp/deployer/blob/master/recipe/contao.php#L62) Download the Contao Manager. @@ -132,7 +132,7 @@ Download the Contao Manager. Downloads the `contao-manager.phar.php` into the public path. -### contao:install:lock +### contao:install:lock {#contao-install-lock} [Source](https://github.com/deployphp/deployer/blob/master/recipe/contao.php#L68) Lock the Contao Install Tool. @@ -140,7 +140,7 @@ Lock the Contao Install Tool. Locks the Contao install tool which is useful if you don't use it. -### contao:manager:lock +### contao:manager:lock {#contao-manager-lock} [Source](https://github.com/deployphp/deployer/blob/master/recipe/contao.php#L74) Lock the Contao Manager. @@ -148,7 +148,7 @@ Lock the Contao Manager. Locks the Contao Manager which is useful if you only need the API of the Manager rather than the UI. -### contao:maintenance:enable +### contao:maintenance:enable {#contao-maintenance-enable} [Source](https://github.com/deployphp/deployer/blob/master/recipe/contao.php#L80) Enable maintenance mode. @@ -156,7 +156,7 @@ Enable maintenance mode. -### contao:maintenance:disable +### contao:maintenance:disable {#contao-maintenance-disable} [Source](https://github.com/deployphp/deployer/blob/master/recipe/contao.php#L95) Disable maintenance mode. @@ -164,7 +164,7 @@ Disable maintenance mode. -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/contao.php#L107) Deploy the project. @@ -173,11 +173,11 @@ Deploy the project. This task is group task which contains next tasks: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) -* [contao:maintenance:enable](/docs/recipe/contao.md#contaomaintenanceenable) -* [contao:migrate](/docs/recipe/contao.md#contaomigrate) -* [contao:maintenance:disable](/docs/recipe/contao.md#contaomaintenancedisable) -* [deploy:publish](/docs/recipe/common.md#deploypublish) +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [contao:maintenance:enable](/docs/recipe/contao.md#contao-maintenance-enable) +* [contao:migrate](/docs/recipe/contao.md#contao-migrate) +* [contao:maintenance:disable](/docs/recipe/contao.md#contao-maintenance-disable) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/craftcms.md b/docs/recipe/craftcms.md index 6a819d802..c3af90e73 100644 --- a/docs/recipe/craftcms.md +++ b/docs/recipe/craftcms.md @@ -28,16 +28,16 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Craftcms** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors The craftcms recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -100,7 +100,7 @@ Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `r ## Tasks -### craft:gc +### craft:gc {#craft-gc} [Source](https://github.com/deployphp/deployer/blob/master/recipe/craftcms.php#L120) Runs garbage collection. @@ -108,7 +108,7 @@ Runs garbage collection. Garbage collection -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/craftcms.php#L127) Deploys Craft CMS. @@ -117,7 +117,7 @@ Main deploy 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:prepare](/docs/recipe/common.md#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) diff --git a/docs/recipe/deploy/check_remote.md b/docs/recipe/deploy/check_remote.md index b8e9e67a9..bb6291146 100644 --- a/docs/recipe/deploy/check_remote.md +++ b/docs/recipe/deploy/check_remote.md @@ -14,7 +14,7 @@ require 'recipe/deploy/check_remote.php'; ## Tasks -### deploy:check_remote +### deploy:check_remote {#deploy-check_remote} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/check_remote.php#L11) Checks remote head. diff --git a/docs/recipe/deploy/cleanup.md b/docs/recipe/deploy/cleanup.md index 7de0ab598..6abfed478 100644 --- a/docs/recipe/deploy/cleanup.md +++ b/docs/recipe/deploy/cleanup.md @@ -25,7 +25,7 @@ false ## Tasks -### deploy:cleanup +### deploy:cleanup {#deploy-cleanup} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/cleanup.php#L9) Cleanup old releases. diff --git a/docs/recipe/deploy/clear_paths.md b/docs/recipe/deploy/clear_paths.md index 111e2dd64..c1d89a755 100644 --- a/docs/recipe/deploy/clear_paths.md +++ b/docs/recipe/deploy/clear_paths.md @@ -32,7 +32,7 @@ false ## Tasks -### deploy:clear_paths +### deploy:clear_paths {#deploy-clear_paths} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/clear_paths.php#L12) Cleanup files and/or directories. diff --git a/docs/recipe/deploy/copy_dirs.md b/docs/recipe/deploy/copy_dirs.md index 12b27b8bb..7fdca5964 100644 --- a/docs/recipe/deploy/copy_dirs.md +++ b/docs/recipe/deploy/copy_dirs.md @@ -23,7 +23,7 @@ For example you can copy `node_modules` to speedup npm install. ## Tasks -### deploy:copy_dirs +### deploy:copy_dirs {#deploy-copy_dirs} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/copy_dirs.php#L10) Copies directories. diff --git a/docs/recipe/deploy/env.md b/docs/recipe/deploy/env.md index 17e13ed93..984380dc3 100644 --- a/docs/recipe/deploy/env.md +++ b/docs/recipe/deploy/env.md @@ -14,7 +14,7 @@ require 'recipe/deploy/env.php'; ## Tasks -### deploy:env +### deploy:env {#deploy-env} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/env.php#L6) Configure .env file. diff --git a/docs/recipe/deploy/info.md b/docs/recipe/deploy/info.md index 432a1d428..e9f3decfe 100644 --- a/docs/recipe/deploy/info.md +++ b/docs/recipe/deploy/info.md @@ -42,7 +42,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### deploy:info +### deploy:info {#deploy-info} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/info.php#L29) Displays info about deployment. diff --git a/docs/recipe/deploy/lock.md b/docs/recipe/deploy/lock.md index 0b5ee9b40..f781af3a4 100644 --- a/docs/recipe/deploy/lock.md +++ b/docs/recipe/deploy/lock.md @@ -14,7 +14,7 @@ require 'recipe/deploy/lock.php'; ## Tasks -### deploy:lock +### deploy:lock {#deploy-lock} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/lock.php#L8) Locks deploy. @@ -22,7 +22,7 @@ Locks deploy. -### deploy:unlock +### deploy:unlock {#deploy-unlock} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/lock.php#L21) Unlocks deploy. @@ -30,7 +30,7 @@ Unlocks deploy. -### deploy:is_locked +### deploy:is_locked {#deploy-is_locked} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/lock.php#L26) Checks if deploy is locked. diff --git a/docs/recipe/deploy/push.md b/docs/recipe/deploy/push.md index 20e2f2d34..19c6b063c 100644 --- a/docs/recipe/deploy/push.md +++ b/docs/recipe/deploy/push.md @@ -14,7 +14,7 @@ require 'recipe/deploy/push.php'; ## Tasks -### push +### push {#push} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/push.php#L9) Pushes local changes to remote host. diff --git a/docs/recipe/deploy/release.md b/docs/recipe/deploy/release.md index 792d3d2d2..5f22af5e0 100644 --- a/docs/recipe/deploy/release.md +++ b/docs/recipe/deploy/release.md @@ -83,7 +83,7 @@ return $releaseExists ? get('release_path') : get('current_path'); ## Tasks -### deploy:release +### deploy:release {#deploy-release} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L85) Prepares release. @@ -91,7 +91,7 @@ Prepares release. Clean up unfinished releases and prepare next release -### releases +### releases {#releases} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L160) Shows releases list. diff --git a/docs/recipe/deploy/rollback.md b/docs/recipe/deploy/rollback.md index 1348b7247..687d16541 100644 --- a/docs/recipe/deploy/rollback.md +++ b/docs/recipe/deploy/rollback.md @@ -36,7 +36,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### rollback +### rollback {#rollback} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/rollback.php#L63) Rollbacks to the previous release. diff --git a/docs/recipe/deploy/setup.md b/docs/recipe/deploy/setup.md index b5778d4cf..7005acc37 100644 --- a/docs/recipe/deploy/setup.md +++ b/docs/recipe/deploy/setup.md @@ -14,7 +14,7 @@ require 'recipe/deploy/setup.php'; ## Tasks -### deploy:setup +### deploy:setup {#deploy-setup} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/setup.php#L6) Prepares host for deploy. diff --git a/docs/recipe/deploy/shared.md b/docs/recipe/deploy/shared.md index 1bd38f0be..0c2ef5fc5 100644 --- a/docs/recipe/deploy/shared.md +++ b/docs/recipe/deploy/shared.md @@ -37,7 +37,7 @@ set('shared_files', ['.env']); ## Tasks -### deploy:shared +### deploy:shared {#deploy-shared} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/shared.php#L23) Creates symlinks for shared files and dirs. diff --git a/docs/recipe/deploy/symlink.md b/docs/recipe/deploy/symlink.md index 3366e6bc6..5f3d75803 100644 --- a/docs/recipe/deploy/symlink.md +++ b/docs/recipe/deploy/symlink.md @@ -25,7 +25,7 @@ return commandSupportsOption('mv', '--no-target-directory'); ## Tasks -### deploy:symlink +### deploy:symlink {#deploy-symlink} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/symlink.php#L11) Creates symlink to release. diff --git a/docs/recipe/deploy/update_code.md b/docs/recipe/deploy/update_code.md index 90dcd0e65..cc203ec49 100644 --- a/docs/recipe/deploy/update_code.md +++ b/docs/recipe/deploy/update_code.md @@ -80,7 +80,7 @@ false ## Tasks -### deploy:update_code +### deploy:update_code {#deploy-update_code} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/update_code.php#L72) Updates code. diff --git a/docs/recipe/deploy/vendors.md b/docs/recipe/deploy/vendors.md index 98a0d4966..04c8a186c 100644 --- a/docs/recipe/deploy/vendors.md +++ b/docs/recipe/deploy/vendors.md @@ -48,7 +48,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### deploy:vendors +### deploy:vendors {#deploy-vendors} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/vendors.php#L28) Installs vendors. diff --git a/docs/recipe/deploy/writable.md b/docs/recipe/deploy/writable.md index adc841206..af54d31b2 100644 --- a/docs/recipe/deploy/writable.md +++ b/docs/recipe/deploy/writable.md @@ -94,7 +94,7 @@ The chmod mode. ## Tasks -### deploy:writable +### deploy:writable {#deploy-writable} [Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L62) Makes writable dirs. diff --git a/docs/recipe/drupal7.md b/docs/recipe/drupal7.md index 375069e3b..416a54b41 100644 --- a/docs/recipe/drupal7.md +++ b/docs/recipe/drupal7.md @@ -28,20 +28,20 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Drupal 7** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The drupal7 recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -102,7 +102,7 @@ Drupal 7 writable dirs ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/drupal7.php#L9) @@ -111,11 +111,11 @@ Drupal 7 writable dirs 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#deploy-prepare) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) -### drupal:settings +### drupal:settings {#drupal-settings} [Source](https://github.com/deployphp/deployer/blob/master/recipe/drupal7.php#L34) @@ -123,7 +123,7 @@ This task is group task which contains next tasks: Create and upload Drupal 7 settings.php using values from secrets -### drupal:upload_files +### drupal:upload_files {#drupal-upload_files} [Source](https://github.com/deployphp/deployer/blob/master/recipe/drupal7.php#L76) diff --git a/docs/recipe/drupal8.md b/docs/recipe/drupal8.md index e49c4aa31..e2c982770 100644 --- a/docs/recipe/drupal8.md +++ b/docs/recipe/drupal8.md @@ -28,20 +28,20 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Drupal 8** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The drupal8 recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -103,7 +103,7 @@ Drupal 8 Writable dirs ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/drupal8.php#L9) @@ -112,7 +112,7 @@ Drupal 8 Writable dirs 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#deploy-prepare) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/flow_framework.md b/docs/recipe/flow_framework.md index 491e15d25..630fc1f2a 100644 --- a/docs/recipe/flow_framework.md +++ b/docs/recipe/flow_framework.md @@ -28,23 +28,23 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Flow Framework** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:run_migrations](/docs/recipe/flow_framework.md#deployrun_migrations) – Applies database migrations -* [deploy:publish_resources](/docs/recipe/flow_framework.md#deploypublish_resources) – Publishes resources -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:run_migrations](/docs/recipe/flow_framework.md#deploy-run_migrations) – Applies database migrations +* [deploy:publish_resources](/docs/recipe/flow_framework.md#deploy-publish_resources) – Publishes resources +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The flow_framework recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -89,7 +89,7 @@ Flow-Framework shared directories ## Tasks -### deploy:run_migrations +### deploy:run_migrations {#deploy-run_migrations} [Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L26) Applies database migrations. @@ -97,7 +97,7 @@ Applies database migrations. Apply database migrations -### deploy:publish_resources +### deploy:publish_resources {#deploy-publish_resources} [Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L34) Publishes resources. @@ -105,7 +105,7 @@ Publishes resources. Publish resources -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/flow_framework.php#L42) Deploys your project. @@ -114,10 +114,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: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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:run_migrations](/docs/recipe/flow_framework.md#deploy-run_migrations) +* [deploy:publish_resources](/docs/recipe/flow_framework.md#deploy-publish_resources) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/fuelphp.md b/docs/recipe/fuelphp.md index c69e3ded3..7e64768d4 100644 --- a/docs/recipe/fuelphp.md +++ b/docs/recipe/fuelphp.md @@ -28,21 +28,21 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Fuelphp** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The fuelphp recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -65,7 +65,7 @@ FuelPHP 1.x shared dirs ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/fuelphp.php#L18) Deploys your project. @@ -74,8 +74,8 @@ 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/joomla.md b/docs/recipe/joomla.md index c88529cbb..d73cd1848 100644 --- a/docs/recipe/joomla.md +++ b/docs/recipe/joomla.md @@ -28,20 +28,20 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Joomla** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The joomla recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -86,7 +86,7 @@ Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `r ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/joomla.php#L14) Deploys your project. @@ -95,7 +95,7 @@ Deploys your project. 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#deploy-prepare) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/laravel.md b/docs/recipe/laravel.md index 949e6b5d1..70938cd6c 100644 --- a/docs/recipe/laravel.md +++ b/docs/recipe/laravel.md @@ -28,28 +28,28 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Laravel** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [artisan:create_key](/docs/recipe/laravel.md#artisancreate_key) – Generates the application key for new deployments -* [artisan:storage:link](/docs/recipe/laravel.md#artisanstoragelink) – Creates the symbolic links configured for the application -* [artisan:config:cache](/docs/recipe/laravel.md#artisanconfigcache) – Creates a cache file for faster configuration loading -* [artisan:route:cache](/docs/recipe/laravel.md#artisanroutecache) – Creates a route cache file for faster route registration -* [artisan:view:cache](/docs/recipe/laravel.md#artisanviewcache) – Compiles all of the application\'s Blade templates -* [artisan:event:cache](/docs/recipe/laravel.md#artisaneventcache) – Discovers and cache the application\'s events and listeners -* [artisan:migrate](/docs/recipe/laravel.md#artisanmigrate) – Runs the database migrations -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [artisan:create_key](/docs/recipe/laravel.md#artisan-create_key) – Generates the application key for new deployments +* [artisan:storage:link](/docs/recipe/laravel.md#artisan-storage-link) – Creates the symbolic links configured for the application +* [artisan:config:cache](/docs/recipe/laravel.md#artisan-config-cache) – Creates a cache file for faster configuration loading +* [artisan:route:cache](/docs/recipe/laravel.md#artisan-route-cache) – Creates a route cache file for faster route registration +* [artisan:view:cache](/docs/recipe/laravel.md#artisan-view-cache) – Compiles all of the application\'s Blade templates +* [artisan:event:cache](/docs/recipe/laravel.md#artisan-event-cache) – Discovers and cache the application\'s events and listeners +* [artisan:migrate](/docs/recipe/laravel.md#artisan-migrate) – Runs the database migrations +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The laravel recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -139,7 +139,7 @@ Overrides [public_path](/docs/recipe/provision/website.md#public_path) from `rec ## Tasks -### artisan:down +### artisan:down {#artisan-down} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L92) Puts the application into maintenance / demo mode. @@ -147,7 +147,7 @@ Puts the application into maintenance / demo mode. Maintenance mode. -### artisan:up +### artisan:up {#artisan-up} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L95) Brings the application out of maintenance mode. @@ -155,7 +155,7 @@ Brings the application out of maintenance mode. -### artisan:​key:generate +### artisan:​key:generate {#artisan-key-generate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L102) Sets the application key. @@ -163,7 +163,7 @@ Sets the application key. Generate keys. -### artisan:create_key +### artisan:create_key {#artisan-create_key} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L105) Generates the application key for new deployments. @@ -171,7 +171,7 @@ Generates the application key for new deployments. -### artisan:passport:keys +### artisan:passport:keys {#artisan-passport-keys} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L112) Creates the encryption keys for API authentication. @@ -179,7 +179,7 @@ Creates the encryption keys for API authentication. -### artisan:db:seed +### artisan:db:seed {#artisan-db-seed} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L119) Seeds the database with records. @@ -187,7 +187,7 @@ Seeds the database with records. Database and migrations. -### artisan:migrate +### artisan:migrate {#artisan-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L122) Runs the database migrations. @@ -195,7 +195,7 @@ Runs the database migrations. -### artisan:migrate:fresh +### artisan:migrate:fresh {#artisan-migrate-fresh} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L125) Drops all tables and re-run all migrations. @@ -203,7 +203,7 @@ Drops all tables and re-run all migrations. -### artisan:migrate:rollback +### artisan:migrate:rollback {#artisan-migrate-rollback} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L128) Rollbacks the last database migration. @@ -211,7 +211,7 @@ Rollbacks the last database migration. -### artisan:migrate:status +### artisan:migrate:status {#artisan-migrate-status} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L131) Shows the status of each migration. @@ -219,7 +219,7 @@ Shows the status of each migration. -### artisan:cache:clear +### artisan:cache:clear {#artisan-cache-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L138) Flushes the application cache. @@ -227,7 +227,7 @@ Flushes the application cache. Cache and optimizations. -### artisan:config:cache +### artisan:config:cache {#artisan-config-cache} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L141) Creates a cache file for faster configuration loading. @@ -235,7 +235,7 @@ Creates a cache file for faster configuration loading. -### artisan:config:clear +### artisan:config:clear {#artisan-config-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L144) Removes the configuration cache file. @@ -243,7 +243,7 @@ Removes the configuration cache file. -### artisan:event:cache +### artisan:event:cache {#artisan-event-cache} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L147) Discovers and cache the application\'s events and listeners. @@ -251,7 +251,7 @@ Discovers and cache the application\'s events and listeners. -### artisan:event:clear +### artisan:event:clear {#artisan-event-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L150) Clears all cached events and listeners. @@ -259,7 +259,7 @@ Clears all cached events and listeners. -### artisan:event:list +### artisan:event:list {#artisan-event-list} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L153) Lists the application\'s events and listeners. @@ -267,7 +267,7 @@ Lists the application\'s events and listeners. -### artisan:optimize +### artisan:optimize {#artisan-optimize} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L156) Cache the framework bootstrap files. @@ -275,7 +275,7 @@ Cache the framework bootstrap files. -### artisan:optimize:clear +### artisan:optimize:clear {#artisan-optimize-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L159) Removes the cached bootstrap files. @@ -283,7 +283,7 @@ Removes the cached bootstrap files. -### artisan:route:cache +### artisan:route:cache {#artisan-route-cache} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L162) Creates a route cache file for faster route registration. @@ -291,7 +291,7 @@ Creates a route cache file for faster route registration. -### artisan:route:clear +### artisan:route:clear {#artisan-route-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L165) Removes the route cache file. @@ -299,7 +299,7 @@ Removes the route cache file. -### artisan:route:list +### artisan:route:list {#artisan-route-list} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L168) Lists all registered routes. @@ -307,7 +307,7 @@ Lists all registered routes. -### artisan:storage:link +### artisan:storage:link {#artisan-storage-link} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L171) Creates the symbolic links configured for the application. @@ -315,7 +315,7 @@ Creates the symbolic links configured for the application. -### artisan:view:cache +### artisan:view:cache {#artisan-view-cache} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L174) Compiles all of the application\'s Blade templates. @@ -323,7 +323,7 @@ Compiles all of the application\'s Blade templates. -### artisan:view:clear +### artisan:view:clear {#artisan-view-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L177) Clears all compiled view files. @@ -331,7 +331,7 @@ Clears all compiled view files. -### artisan:queue:failed +### artisan:queue:failed {#artisan-queue-failed} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L184) Lists all of the failed queue jobs. @@ -339,7 +339,7 @@ Lists all of the failed queue jobs. Queue and Horizon. -### artisan:queue:flush +### artisan:queue:flush {#artisan-queue-flush} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L187) Flushes all of the failed queue jobs. @@ -347,7 +347,7 @@ Flushes all of the failed queue jobs. -### artisan:queue:restart +### artisan:queue:restart {#artisan-queue-restart} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L190) Restarts queue worker daemons after their current job. @@ -355,7 +355,7 @@ Restarts queue worker daemons after their current job. -### artisan:horizon +### artisan:horizon {#artisan-horizon} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L193) Starts a master supervisor in the foreground. @@ -363,7 +363,7 @@ Starts a master supervisor in the foreground. -### artisan:horizon:clear +### artisan:horizon:clear {#artisan-horizon-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L196) Deletes all of the jobs from the specified queue. @@ -371,7 +371,7 @@ Deletes all of the jobs from the specified queue. -### artisan:horizon:continue +### artisan:horizon:continue {#artisan-horizon-continue} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L199) Instructs the master supervisor to continue processing jobs. @@ -379,7 +379,7 @@ Instructs the master supervisor to continue processing jobs. -### artisan:horizon:list +### artisan:horizon:list {#artisan-horizon-list} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L202) Lists all of the deployed machines. @@ -387,7 +387,7 @@ Lists all of the deployed machines. -### artisan:horizon:pause +### artisan:horizon:pause {#artisan-horizon-pause} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L205) Pauses the master supervisor. @@ -395,7 +395,7 @@ Pauses the master supervisor. -### artisan:horizon:purge +### artisan:horizon:purge {#artisan-horizon-purge} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L208) Terminates any rogue Horizon processes. @@ -403,7 +403,7 @@ Terminates any rogue Horizon processes. -### artisan:horizon:status +### artisan:horizon:status {#artisan-horizon-status} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L211) Gets the current status of Horizon. @@ -411,7 +411,7 @@ Gets the current status of Horizon. -### artisan:horizon:terminate +### artisan:horizon:terminate {#artisan-horizon-terminate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L214) Terminates the master supervisor so it can be restarted. @@ -419,7 +419,7 @@ Terminates the master supervisor so it can be restarted. -### artisan:horizon:publish +### artisan:horizon:publish {#artisan-horizon-publish} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L217) Publish all of the Horizon resources. @@ -427,7 +427,7 @@ Publish all of the Horizon resources. -### artisan:​telescope:clear +### artisan:​telescope:clear {#artisan-telescope-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L224) Clears all entries from Telescope. @@ -435,7 +435,7 @@ Clears all entries from Telescope. Telescope. -### artisan:​telescope:prune +### artisan:​telescope:prune {#artisan-telescope-prune} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L227) Prunes stale entries from the Telescope database. @@ -443,7 +443,7 @@ Prunes stale entries from the Telescope database. -### artisan:octane +### artisan:octane {#artisan-octane} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L234) Starts the octane server. @@ -451,7 +451,7 @@ Starts the octane server. Octane. -### artisan:octane:reload +### artisan:octane:reload {#artisan-octane-reload} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L237) Reloads the octane server. @@ -459,7 +459,7 @@ Reloads the octane server. -### artisan:octane:stop +### artisan:octane:stop {#artisan-octane-stop} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L240) Stops the octane server. @@ -467,7 +467,7 @@ Stops the octane server. -### artisan:octane:status +### artisan:octane:status {#artisan-octane-status} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L243) Check the status of the octane server. @@ -475,7 +475,7 @@ Check the status of the octane server. -### artisan:nova:publish +### artisan:nova:publish {#artisan-nova-publish} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L250) Publish all of the Laravel Nova resources. @@ -483,7 +483,7 @@ Publish all of the Laravel Nova resources. Nova. -### artisan:reverb:start +### artisan:reverb:start {#artisan-reverb-start} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L257) Starts the Reverb server. @@ -491,7 +491,7 @@ Starts the Reverb server. Reverb. -### artisan:reverb:restart +### artisan:reverb:restart {#artisan-reverb-restart} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L260) Restarts the Reverb server. @@ -499,7 +499,7 @@ Restarts the Reverb server. -### artisan:pulse:check +### artisan:pulse:check {#artisan-pulse-check} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L267) Starts the Pulse server. @@ -507,7 +507,7 @@ Starts the Pulse server. Pulse. -### artisan:pulse:restart +### artisan:pulse:restart {#artisan-pulse-restart} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L270) Restarts the Pulse server. @@ -515,7 +515,7 @@ Restarts the Pulse server. -### artisan:pulse:purge +### artisan:pulse:purge {#artisan-pulse-purge} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L273) Purges all Pulse data from storage. @@ -523,7 +523,7 @@ Purges all Pulse data from storage. -### artisan:pulse:work +### artisan:pulse:work {#artisan-pulse-work} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L276) Process incoming Pulse data from the ingest stream. @@ -531,7 +531,7 @@ Process incoming Pulse data from the ingest stream. -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L282) Deploys your project. @@ -540,15 +540,15 @@ 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:create_key](/docs/recipe/laravel.md#artisancreate_key) -* [artisan:storage:link](/docs/recipe/laravel.md#artisanstoragelink) -* [artisan:config:cache](/docs/recipe/laravel.md#artisanconfigcache) -* [artisan:route:cache](/docs/recipe/laravel.md#artisanroutecache) -* [artisan:view:cache](/docs/recipe/laravel.md#artisanviewcache) -* [artisan:event:cache](/docs/recipe/laravel.md#artisaneventcache) -* [artisan:migrate](/docs/recipe/laravel.md#artisanmigrate) -* [deploy:publish](/docs/recipe/common.md#deploypublish) +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [artisan:create_key](/docs/recipe/laravel.md#artisan-create_key) +* [artisan:storage:link](/docs/recipe/laravel.md#artisan-storage-link) +* [artisan:config:cache](/docs/recipe/laravel.md#artisan-config-cache) +* [artisan:route:cache](/docs/recipe/laravel.md#artisan-route-cache) +* [artisan:view:cache](/docs/recipe/laravel.md#artisan-view-cache) +* [artisan:event:cache](/docs/recipe/laravel.md#artisan-event-cache) +* [artisan:migrate](/docs/recipe/laravel.md#artisan-migrate) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/magento.md b/docs/recipe/magento.md index 23ab37874..a098b1259 100644 --- a/docs/recipe/magento.md +++ b/docs/recipe/magento.md @@ -28,21 +28,21 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Magento** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:cache:clear](/docs/recipe/magento.md#deploycacheclear) – Clears cache -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:cache:clear](/docs/recipe/magento.md#deploy-cache-clear) – Clears cache +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The magento recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -88,7 +88,7 @@ Magento writable dirs ## Tasks -### deploy:cache:clear +### deploy:cache:clear {#deploy-cache-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L26) Clears cache. @@ -96,7 +96,7 @@ Clears cache. Clear cache -### deploy:clear_version +### deploy:clear_version {#deploy-clear_version} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L33) @@ -104,7 +104,7 @@ Clear cache Remove files that can be used to compromise Magento -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento.php#L47) Deploys your project. @@ -113,8 +113,8 @@ 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#deploy-prepare) +* [deploy:cache:clear](/docs/recipe/magento.md#deploy-cache-clear) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/magento2.md b/docs/recipe/magento2.md index c7313f6a5..be9972035 100644 --- a/docs/recipe/magento2.md +++ b/docs/recipe/magento2.md @@ -28,30 +28,30 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Magento 2** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deployclear_paths) – Cleanup files and/or directories -* [deploy:magento](/docs/recipe/magento2.md#deploymagento) – Magento2 deployment operations - * [magento:build](/docs/recipe/magento2.md#magentobuild) – Magento2 build operations - * [magento:compile](/docs/recipe/magento2.md#magentocompile) – Compiles magento di - * [magento:deploy:assets](/docs/recipe/magento2.md#magentodeployassets) – Deploys assets - * [magento:maintenance:enable-if-needed](/docs/recipe/magento2.md#magentomaintenanceenable-if-needed) – Set maintenance mode if needed - * [magento:config:import](/docs/recipe/magento2.md#magentoconfigimport) – Config Import - * [magento:upgrade:db](/docs/recipe/magento2.md#magentoupgradedb) – Upgrades magento database - * [magento:maintenance:disable](/docs/recipe/magento2.md#magentomaintenancedisable) – Disables maintenance mode -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deploy-clear_paths) – Cleanup files and/or directories +* [deploy:magento](/docs/recipe/magento2.md#deploy-magento) – Magento2 deployment operations + * [magento:build](/docs/recipe/magento2.md#magento-build) – Magento2 build operations + * [magento:compile](/docs/recipe/magento2.md#magento-compile) – Compiles magento di + * [magento:deploy:assets](/docs/recipe/magento2.md#magento-deploy-assets) – Deploys assets + * [magento:maintenance:enable-if-needed](/docs/recipe/magento2.md#magento-maintenance-enable-if-needed) – Set maintenance mode if needed + * [magento:config:import](/docs/recipe/magento2.md#magento-config-import) – Config Import + * [magento:upgrade:db](/docs/recipe/magento2.md#magento-upgrade-db) – Upgrades magento database + * [magento:maintenance:disable](/docs/recipe/magento2.md#magento-maintenance-disable) – Disables maintenance mode +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project In addition the **Magento 2** recipe contains an artifact deployment. @@ -80,36 +80,36 @@ hosts: ``` to your deploy yaml. -The [artifact:build](#artifact:build) command of **Magento 2** consists of: * [build:prepare](/docs/recipe/magento2.md#buildprepare) – Prepare local artifact build -* [build:remove-generated](/docs/recipe/magento2.md#buildremove-generated) – Clears generated files prior to building. -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [magento:compile](/docs/recipe/magento2.md#magentocompile) – Compiles magento di -* [magento:deploy:assets](/docs/recipe/magento2.md#magentodeployassets) – Deploys assets -* [artifact:package](/docs/recipe/magento2.md#artifactpackage) – Packages all relevant files in an artifact. +The [artifact:build](#artifact:build) command of **Magento 2** consists of: * [build:prepare](/docs/recipe/magento2.md#build-prepare) – Prepare local artifact build +* [build:remove-generated](/docs/recipe/magento2.md#build-remove-generated) – Clears generated files prior to building. +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [magento:compile](/docs/recipe/magento2.md#magento-compile) – Compiles magento di +* [magento:deploy:assets](/docs/recipe/magento2.md#magento-deploy-assets) – Deploys assets +* [artifact:package](/docs/recipe/magento2.md#artifact-package) – Packages all relevant files in an artifact. The [artifact:deploy](#artifact:deploy) command of **Magento 2** consists of: -* [artifact:prepare](/docs/recipe/magento2.md#artifactprepare) – Prepares an artifact on the target server - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [artifact:upload](/docs/recipe/magento2.md#artifactupload) – Uploads artifact in release folder for extraction. - * [artifact:extract](/docs/recipe/magento2.md#artifactextract) – Extracts artifact in release path. - * [deploy:additional-shared](/docs/recipe/magento2.md#deployadditional-shared) – Adds additional files and dirs to the list of shared files and dirs - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [magento:maintenance:enable-if-needed](/docs/recipe/magento2.md#magentomaintenanceenable-if-needed) – Set maintenance mode if needed -* [magento:config:import](/docs/recipe/magento2.md#magentoconfigimport) – Config Import -* [magento:upgrade:db](/docs/recipe/magento2.md#magentoupgradedb) – Upgrades magento database -* [magento:maintenance:disable](/docs/recipe/magento2.md#magentomaintenancedisable) – Disables maintenance mode -* [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release -* [artifact:finish](/docs/recipe/magento2.md#artifactfinish) – Executes the tasks after artifact is released - * [magento:cache:flush](/docs/recipe/magento2.md#magentocacheflush) – Flushes Magento Cache - * [cachetool:clear:opcache](/docs/contrib/cachetool.md#cachetoolclearopcache) – Clears OPcode cache - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [artifact:prepare](/docs/recipe/magento2.md#artifact-prepare) – Prepares an artifact on the target server + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [artifact:upload](/docs/recipe/magento2.md#artifact-upload) – Uploads artifact in release folder for extraction. + * [artifact:extract](/docs/recipe/magento2.md#artifact-extract) – Extracts artifact in release path. + * [deploy:additional-shared](/docs/recipe/magento2.md#deploy-additional-shared) – Adds additional files and dirs to the list of shared files and dirs + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [magento:maintenance:enable-if-needed](/docs/recipe/magento2.md#magento-maintenance-enable-if-needed) – Set maintenance mode if needed +* [magento:config:import](/docs/recipe/magento2.md#magento-config-import) – Config Import +* [magento:upgrade:db](/docs/recipe/magento2.md#magento-upgrade-db) – Upgrades magento database +* [magento:maintenance:disable](/docs/recipe/magento2.md#magento-maintenance-disable) – Disables maintenance mode +* [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release +* [artifact:finish](/docs/recipe/magento2.md#artifact-finish) – Executes the tasks after artifact is released + * [magento:cache:flush](/docs/recipe/magento2.md#magento-cache-flush) – Flushes Magento Cache + * [cachetool:clear:opcache](/docs/contrib/cachetool.md#cachetool-clear-opcache) – Clears OPcode cache + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The magento2 recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -451,7 +451,7 @@ Array of shared directories that will be added to the default shared_dirs withou ## Tasks -### magento:compile +### magento:compile {#magento-compile} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L158) Compiles magento di. @@ -464,7 +464,7 @@ e.g. ``` -### magento:deploy:assets +### magento:deploy:assets {#magento-deploy-assets} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L184) Deploys assets. @@ -491,7 +491,7 @@ in `app/etc/config.php`, e.g.: ``` -### magento:deploy:assets:adminhtml +### magento:deploy:assets:adminhtml {#magento-deploy-assets-adminhtml} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L201) Deploys assets for backend only. @@ -499,7 +499,7 @@ Deploys assets for backend only. -### magento:deploy:assets:frontend +### magento:deploy:assets:frontend {#magento-deploy-assets-frontend} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L206) Deploys assets for frontend only. @@ -507,7 +507,7 @@ Deploys assets for frontend only. -### magento:sync:content_version +### magento:sync:content_version {#magento-sync-content_version} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L254) Syncs content version. @@ -515,7 +515,7 @@ Syncs content version. -### magento:maintenance:enable +### magento:maintenance:enable {#magento-maintenance-enable} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L264) Enables maintenance mode. @@ -523,7 +523,7 @@ Enables maintenance mode. -### magento:maintenance:disable +### magento:maintenance:disable {#magento-maintenance-disable} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L270) Disables maintenance mode. @@ -531,7 +531,7 @@ Disables maintenance mode. -### magento:maintenance:enable-if-needed +### magento:maintenance:enable-if-needed {#magento-maintenance-enable-if-needed} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L276) Set maintenance mode if needed. @@ -539,7 +539,7 @@ Set maintenance mode if needed. -### magento:config:import +### magento:config:import {#magento-config-import} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L283) Config Import. @@ -547,7 +547,7 @@ Config Import. -### magento:upgrade:db +### magento:upgrade:db {#magento-upgrade-db} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L292) Upgrades magento database. @@ -555,7 +555,7 @@ Upgrades magento database. -### magento:cache:flush +### magento:cache:flush {#magento-cache-flush} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L302) Flushes Magento Cache. @@ -563,7 +563,7 @@ Flushes Magento Cache. -### deploy:magento +### deploy:magento {#deploy-magento} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L307) Magento2 deployment operations. @@ -572,14 +572,14 @@ Magento2 deployment operations. This task is group task which contains next tasks: -* [magento:build](/docs/recipe/magento2.md#magentobuild) -* [magento:maintenance:enable-if-needed](/docs/recipe/magento2.md#magentomaintenanceenable-if-needed) -* [magento:config:import](/docs/recipe/magento2.md#magentoconfigimport) -* [magento:upgrade:db](/docs/recipe/magento2.md#magentoupgradedb) -* [magento:maintenance:disable](/docs/recipe/magento2.md#magentomaintenancedisable) +* [magento:build](/docs/recipe/magento2.md#magento-build) +* [magento:maintenance:enable-if-needed](/docs/recipe/magento2.md#magento-maintenance-enable-if-needed) +* [magento:config:import](/docs/recipe/magento2.md#magento-config-import) +* [magento:upgrade:db](/docs/recipe/magento2.md#magento-upgrade-db) +* [magento:maintenance:disable](/docs/recipe/magento2.md#magento-maintenance-disable) -### magento:build +### magento:build {#magento-build} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L316) Magento2 build operations. @@ -588,11 +588,11 @@ Magento2 build operations. 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:compile](/docs/recipe/magento2.md#magento-compile) +* [magento:deploy:assets](/docs/recipe/magento2.md#magento-deploy-assets) -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L322) Deploys your project. @@ -601,14 +601,14 @@ Deploys your project. 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deploy-clear_paths) +* [deploy:magento](/docs/recipe/magento2.md#deploy-magento) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) -### artifact:package +### artifact:package {#artifact-package} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L372) Packages all relevant files in an artifact. @@ -616,7 +616,7 @@ Packages all relevant files in an artifact. tasks section -### artifact:upload +### artifact:upload {#artifact-upload} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L382) Uploads artifact in release folder for extraction. @@ -624,7 +624,7 @@ Uploads artifact in release folder for extraction. -### artifact:extract +### artifact:extract {#artifact-extract} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L387) Extracts artifact in release path. @@ -632,7 +632,7 @@ Extracts artifact in release path. -### build:remove-generated +### build:remove-generated {#build-remove-generated} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L393) Clears generated files prior to building. @@ -640,7 +640,7 @@ Clears generated files prior to building. -### build:prepare +### build:prepare {#build-prepare} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L398) Prepare local artifact build. @@ -648,7 +648,7 @@ Prepare local artifact build. -### artifact:build +### artifact:build {#artifact-build} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L423) Builds an artifact. @@ -657,15 +657,15 @@ Builds an artifact. This task is group task which contains next tasks: -* [build:prepare](/docs/recipe/magento2.md#buildprepare) -* [build:remove-generated](/docs/recipe/magento2.md#buildremove-generated) -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) -* [magento:compile](/docs/recipe/magento2.md#magentocompile) -* [magento:deploy:assets](/docs/recipe/magento2.md#magentodeployassets) -* [artifact:package](/docs/recipe/magento2.md#artifactpackage) +* [build:prepare](/docs/recipe/magento2.md#build-prepare) +* [build:remove-generated](/docs/recipe/magento2.md#build-remove-generated) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [magento:compile](/docs/recipe/magento2.md#magento-compile) +* [magento:deploy:assets](/docs/recipe/magento2.md#magento-deploy-assets) +* [artifact:package](/docs/recipe/magento2.md#artifact-package) -### deploy:additional-shared +### deploy:additional-shared {#deploy-additional-shared} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L439) Adds additional files and dirs to the list of shared files and dirs. @@ -673,7 +673,7 @@ Adds additional files and dirs to the list of shared files and dirs. -### magento:set_cache_prefix +### magento:set_cache_prefix {#magento-set_cache_prefix} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L454) Update cache id_prefix. @@ -687,7 +687,7 @@ after('deploy:magento', 'magento:cleanup_cache_prefix'); ``` -### magento:cleanup_cache_prefix +### magento:cleanup_cache_prefix {#magento-cleanup_cache_prefix} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L494) Cleanup cache id_prefix env files. @@ -695,7 +695,7 @@ Cleanup cache id_prefix env files. After successful deployment, move the tmp_env.php file to env.php ready for next deployment -### magento:cron:stop +### magento:cron:stop {#magento-cron-stop} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L510) Remove cron from crontab and kill running cron jobs. @@ -707,7 +707,7 @@ To use this feature, add the following to your deployer scripts: ``` -### magento:cron:install +### magento:cron:install {#magento-cron-install} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L526) Install cron in crontab. @@ -719,7 +719,7 @@ To use this feature, add the following to your deployer scripts: ``` -### artifact:prepare +### artifact:prepare {#artifact-prepare} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L532) Prepares an artifact on the target server. @@ -728,18 +728,18 @@ Prepares an artifact on the target server. 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) -* [artifact:upload](/docs/recipe/magento2.md#artifactupload) -* [artifact:extract](/docs/recipe/magento2.md#artifactextract) -* [deploy:additional-shared](/docs/recipe/magento2.md#deployadditional-shared) -* [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) -* [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) - - -### artifact:finish +* [deploy:info](/docs/recipe/deploy/info.md#deploy-info) +* [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) +* [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) +* [deploy:release](/docs/recipe/deploy/release.md#deploy-release) +* [artifact:upload](/docs/recipe/magento2.md#artifact-upload) +* [artifact:extract](/docs/recipe/magento2.md#artifact-extract) +* [deploy:additional-shared](/docs/recipe/magento2.md#deploy-additional-shared) +* [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) +* [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) + + +### artifact:finish {#artifact-finish} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L545) Executes the tasks after artifact is released. @@ -748,14 +748,14 @@ Executes the tasks after artifact is released. This task is group task which contains next tasks: -* [magento:cache:flush](/docs/recipe/magento2.md#magentocacheflush) -* [cachetool:clear:opcache](/docs/contrib/cachetool.md#cachetoolclearopcache) -* [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) -* [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) -* [deploy:success](/docs/recipe/common.md#deploysuccess) +* [magento:cache:flush](/docs/recipe/magento2.md#magento-cache-flush) +* [cachetool:clear:opcache](/docs/contrib/cachetool.md#cachetool-clear-opcache) +* [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) +* [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) +* [deploy:success](/docs/recipe/common.md#deploy-success) -### artifact:deploy +### artifact:deploy {#artifact-deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L554) Actually releases the artifact deployment. @@ -764,12 +764,12 @@ Actually releases the artifact deployment. This task is group task which contains next tasks: -* [artifact:prepare](/docs/recipe/magento2.md#artifactprepare) -* [magento:maintenance:enable-if-needed](/docs/recipe/magento2.md#magentomaintenanceenable-if-needed) -* [magento:config:import](/docs/recipe/magento2.md#magentoconfigimport) -* [magento:upgrade:db](/docs/recipe/magento2.md#magentoupgradedb) -* [magento:maintenance:disable](/docs/recipe/magento2.md#magentomaintenancedisable) -* [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) -* [artifact:finish](/docs/recipe/magento2.md#artifactfinish) +* [artifact:prepare](/docs/recipe/magento2.md#artifact-prepare) +* [magento:maintenance:enable-if-needed](/docs/recipe/magento2.md#magento-maintenance-enable-if-needed) +* [magento:config:import](/docs/recipe/magento2.md#magento-config-import) +* [magento:upgrade:db](/docs/recipe/magento2.md#magento-upgrade-db) +* [magento:maintenance:disable](/docs/recipe/magento2.md#magento-maintenance-disable) +* [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) +* [artifact:finish](/docs/recipe/magento2.md#artifact-finish) diff --git a/docs/recipe/pimcore.md b/docs/recipe/pimcore.md index 86f541a0d..dcb02c477 100644 --- a/docs/recipe/pimcore.md +++ b/docs/recipe/pimcore.md @@ -28,22 +28,22 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Pimcore** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:cache:clear](/docs/recipe/symfony.md#deploycacheclear) – Clears cache -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:cache:clear](/docs/recipe/symfony.md#deploy-cache-clear) – Clears cache +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The pimcore recipe is based on the [symfony](/docs/recipe/symfony.md) recipe. @@ -51,7 +51,7 @@ The pimcore recipe is based on the [symfony](/docs/recipe/symfony.md) recipe. ## Tasks -### pimcore:rebuild-classes +### pimcore:rebuild-classes {#pimcore-rebuild-classes} [Source](https://github.com/deployphp/deployer/blob/master/recipe/pimcore.php#L16) Rebuilds Pimcore Classes. @@ -59,7 +59,7 @@ Rebuilds Pimcore Classes. -### pimcore:cache_clear +### pimcore:cache_clear {#pimcore-cache_clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/pimcore.php#L21) Removes cache. @@ -67,7 +67,7 @@ Removes cache. -### pimcore:deploy +### pimcore:deploy {#pimcore-deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/pimcore.php#L25) @@ -76,7 +76,7 @@ Removes cache. This task is group task which contains next tasks: -* [pimcore:rebuild-classes](/docs/recipe/pimcore.md#pimcorerebuild-classes) -* [pimcore:cache_clear](/docs/recipe/pimcore.md#pimcorecache_clear) +* [pimcore:rebuild-classes](/docs/recipe/pimcore.md#pimcore-rebuild-classes) +* [pimcore:cache_clear](/docs/recipe/pimcore.md#pimcore-cache_clear) diff --git a/docs/recipe/prestashop.md b/docs/recipe/prestashop.md index 3d4daaf7d..6c7c60e45 100644 --- a/docs/recipe/prestashop.md +++ b/docs/recipe/prestashop.md @@ -28,20 +28,20 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Prestashop** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The prestashop recipe is based on the [common](/docs/recipe/common.md) recipe. diff --git a/docs/recipe/provision.md b/docs/recipe/provision.md index e0ba8cdd6..f445fdac1 100644 --- a/docs/recipe/provision.md +++ b/docs/recipe/provision.md @@ -42,7 +42,7 @@ Default user to use for provisioning. ## Tasks -### provision +### provision {#provision} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L24) Provision the server. @@ -51,24 +51,24 @@ Provision the server. This task is group task which contains next tasks: -* [provision:check](/docs/recipe/provision.md#provisioncheck) -* [provision:configure](/docs/recipe/provision.md#provisionconfigure) -* [provision:update](/docs/recipe/provision.md#provisionupdate) -* [provision:upgrade](/docs/recipe/provision.md#provisionupgrade) -* [provision:install](/docs/recipe/provision.md#provisioninstall) -* [provision:ssh](/docs/recipe/provision.md#provisionssh) -* [provision:firewall](/docs/recipe/provision.md#provisionfirewall) -* [provision:user](/docs/recipe/provision/user.md#provisionuser) -* [provision:php](/docs/recipe/provision/php.md#provisionphp) -* [provision:node](/docs/recipe/provision/nodejs.md#provisionnode) -* [provision:databases](/docs/recipe/provision/databases.md#provisiondatabases) -* [provision:composer](/docs/recipe/provision/php.md#provisioncomposer) -* [provision:server](/docs/recipe/provision/website.md#provisionserver) -* [provision:website](/docs/recipe/provision/website.md#provisionwebsite) -* [provision:verify](/docs/recipe/provision.md#provisionverify) - - -### provision:check +* [provision:check](/docs/recipe/provision.md#provision-check) +* [provision:configure](/docs/recipe/provision.md#provision-configure) +* [provision:update](/docs/recipe/provision.md#provision-update) +* [provision:upgrade](/docs/recipe/provision.md#provision-upgrade) +* [provision:install](/docs/recipe/provision.md#provision-install) +* [provision:ssh](/docs/recipe/provision.md#provision-ssh) +* [provision:firewall](/docs/recipe/provision.md#provision-firewall) +* [provision:user](/docs/recipe/provision/user.md#provision-user) +* [provision:php](/docs/recipe/provision/php.md#provision-php) +* [provision:node](/docs/recipe/provision/nodejs.md#provision-node) +* [provision:databases](/docs/recipe/provision/databases.md#provision-databases) +* [provision:composer](/docs/recipe/provision/php.md#provision-composer) +* [provision:server](/docs/recipe/provision/website.md#provision-server) +* [provision:website](/docs/recipe/provision/website.md#provision-website) +* [provision:verify](/docs/recipe/provision.md#provision-verify) + + +### provision:check {#provision-check} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L46) Checks pre-required state. @@ -76,7 +76,7 @@ Checks pre-required state. -### provision:configure +### provision:configure {#provision-configure} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L71) Collects required params. @@ -84,7 +84,7 @@ Collects required params. -### provision:update +### provision:update {#provision-update} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L123) Adds repositories and update. @@ -92,7 +92,7 @@ Adds repositories and update. -### provision:upgrade +### provision:upgrade {#provision-upgrade} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L140) Upgrades all packages. @@ -100,7 +100,7 @@ Upgrades all packages. -### provision:install +### provision:install {#provision-install} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L148) Installs packages. @@ -108,7 +108,7 @@ Installs packages. -### provision:ssh +### provision:ssh {#provision-ssh} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L183) Configures the ssh. @@ -116,7 +116,7 @@ Configures the ssh. -### provision:firewall +### provision:firewall {#provision-firewall} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L195) Setups a firewall. @@ -124,7 +124,7 @@ Setups a firewall. -### provision:verify +### provision:verify {#provision-verify} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L204) Verifies what provision was successful. diff --git a/docs/recipe/provision/databases.md b/docs/recipe/provision/databases.md index 2ef133460..837964bd0 100644 --- a/docs/recipe/provision/databases.md +++ b/docs/recipe/provision/databases.md @@ -56,7 +56,7 @@ return askHiddenResponse(' DB password: '); ## Tasks -### provision:databases +### provision:databases {#provision-databases} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/databases.php#L28) Provision databases. @@ -64,7 +64,7 @@ Provision databases. -### provision:mysql +### provision:mysql {#provision-mysql} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/databases.php#L40) Provision MySQL. @@ -72,7 +72,7 @@ Provision MySQL. -### provision:mariadb +### provision:mariadb {#provision-mariadb} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/databases.php#L51) Provision MariaDB. @@ -80,7 +80,7 @@ Provision MariaDB. -### provision:postgresql +### provision:postgresql {#provision-postgresql} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/databases.php#L62) Provision PostgreSQL. diff --git a/docs/recipe/provision/nodejs.md b/docs/recipe/provision/nodejs.md index e7c56a2fd..f4df26fd1 100644 --- a/docs/recipe/provision/nodejs.md +++ b/docs/recipe/provision/nodejs.md @@ -25,7 +25,7 @@ require 'recipe/provision/nodejs.php'; ## Tasks -### provision:node +### provision:node {#provision-node} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/nodejs.php#L11) Installs npm packages. diff --git a/docs/recipe/provision/php.md b/docs/recipe/provision/php.md index 144255456..c00fba1c3 100644 --- a/docs/recipe/provision/php.md +++ b/docs/recipe/provision/php.md @@ -28,7 +28,7 @@ return ask(' What PHP version to install? ', $defaultPhpVersion, ['5.6', '7.4', ## Tasks -### provision:php +### provision:php {#provision-php} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/php.php#L13) Installs PHP packages. @@ -36,7 +36,7 @@ Installs PHP packages. -### logs:php-fpm +### logs:php-fpm {#logs-php-fpm} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/php.php#L68) Shows php-fpm logs. @@ -44,7 +44,7 @@ Shows php-fpm logs. -### provision:composer +### provision:composer {#provision-composer} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/php.php#L77) Installs Composer. diff --git a/docs/recipe/provision/user.md b/docs/recipe/provision/user.md index 12aec6b7d..19b0545c9 100644 --- a/docs/recipe/provision/user.md +++ b/docs/recipe/provision/user.md @@ -25,7 +25,7 @@ return askHiddenResponse(' Password for sudo: '); ## Tasks -### provision:user +### provision:user {#provision-user} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/user.php#L13) Setups a deployer user. @@ -33,7 +33,7 @@ Setups a deployer user. -### provision:ssh_copy_id +### provision:ssh_copy_id {#provision-ssh_copy_id} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/user.php#L59) Copy public key to remote server. diff --git a/docs/recipe/provision/website.md b/docs/recipe/provision/website.md index 4f2d20825..09f1b7828 100644 --- a/docs/recipe/provision/website.md +++ b/docs/recipe/provision/website.md @@ -35,7 +35,7 @@ return ask(' Public path: ', 'public'); ## Tasks -### provision:server +### provision:server {#provision-server} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/website.php#L18) Configures a server. @@ -43,7 +43,7 @@ Configures a server. -### provision:website +### provision:website {#provision-website} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/website.php#L27) Provision website. @@ -51,7 +51,7 @@ Provision website. -### logs:access +### logs:access {#logs-access} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/website.php#L71) Shows access logs. @@ -59,7 +59,7 @@ Shows access logs. -### logs:caddy +### logs:caddy {#logs-caddy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/provision/website.php#L76) Shows caddy syslog. diff --git a/docs/recipe/shopware.md b/docs/recipe/shopware.md index 5ac34d4bf..1caaeddaf 100644 --- a/docs/recipe/shopware.md +++ b/docs/recipe/shopware.md @@ -28,31 +28,31 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Shopware** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [sw:writable:jwt](/docs/recipe/shopware.md#swwritablejwt) – -* [sw:deploy](/docs/recipe/shopware.md#swdeploy) – - * [sw:database:migrate](/docs/recipe/shopware.md#swdatabasemigrate) – - * [sw:plugin:refresh](/docs/recipe/shopware.md#swpluginrefresh) – - * [sw:theme:refresh](/docs/recipe/shopware.md#swthemerefresh) – - * [sw:scheduled-task:register](/docs/recipe/shopware.md#swscheduled-taskregister) – - * [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear) – - * [sw:plugin:update:all](/docs/recipe/shopware.md#swpluginupdateall) – - * [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear) – -* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deployclear_paths) – Cleanup files and/or directories -* [sw:cache:warmup](/docs/recipe/shopware.md#swcachewarmup) – -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [sw:writable:jwt](/docs/recipe/shopware.md#sw-writable-jwt) – +* [sw:deploy](/docs/recipe/shopware.md#sw-deploy) – + * [sw:database:migrate](/docs/recipe/shopware.md#sw-database-migrate) – + * [sw:plugin:refresh](/docs/recipe/shopware.md#sw-plugin-refresh) – + * [sw:theme:refresh](/docs/recipe/shopware.md#sw-theme-refresh) – + * [sw:scheduled-task:register](/docs/recipe/shopware.md#sw-scheduled-task-register) – + * [sw:cache:clear](/docs/recipe/shopware.md#sw-cache-clear) – + * [sw:plugin:update:all](/docs/recipe/shopware.md#sw-plugin-update-all) – + * [sw:cache:clear](/docs/recipe/shopware.md#sw-cache-clear) – +* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deploy-clear_paths) – Cleanup files and/or directories +* [sw:cache:warmup](/docs/recipe/shopware.md#sw-cache-warmup) – +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The shopware recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -169,7 +169,7 @@ Please note that the files in `config/jwt/*` receive special attention in the `s ## Tasks -### sw:cache:clear +### sw:cache:clear {#sw-cache-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L75) @@ -177,7 +177,7 @@ Please note that the files in `config/jwt/*` receive special attention in the `s This task remotely executes the `cache:clear` console command on the target server. -### sw:cache:warmup +### sw:cache:warmup {#sw-cache-warmup} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L81) @@ -186,7 +186,7 @@ This task remotely executes the cache warmup console commands on the target serv visits the website, doesn't have to wait for the cache to be built up. -### sw:database:migrate +### sw:database:migrate {#sw-database-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L87) @@ -194,7 +194,7 @@ visits the website, doesn't have to wait for the cache to be built up. This task remotely executes the `database:migrate` console command on the target server. -### sw:plugin:refresh +### sw:plugin:refresh {#sw-plugin-refresh} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L91) @@ -202,7 +202,7 @@ This task remotely executes the `database:migrate` console command on the target -### sw:scheduled-task:register +### sw:scheduled-task:register {#sw-scheduled-task-register} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L95) @@ -210,7 +210,7 @@ This task remotely executes the `database:migrate` console command on the target -### sw:theme:refresh +### sw:theme:refresh {#sw-theme-refresh} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L99) @@ -218,7 +218,7 @@ This task remotely executes the `database:migrate` console command on the target -### sw:theme:compile +### sw:theme:compile {#sw-theme-compile} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L105) @@ -227,7 +227,7 @@ This task is not used per default, but can be used, e.g. in combination with `SH to build the theme remotely instead of locally. -### sw:plugin:update:all +### sw:plugin:update:all {#sw-plugin-update-all} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L117) @@ -235,7 +235,7 @@ to build the theme remotely instead of locally. -### sw:writable:jwt +### sw:writable:jwt {#sw-writable-jwt} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L127) @@ -243,7 +243,7 @@ to build the theme remotely instead of locally. -### sw:deploy +### sw:deploy {#sw-deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L134) @@ -252,16 +252,16 @@ Grouped SW deploy tasks. This task is group task which contains next tasks: -* [sw:database:migrate](/docs/recipe/shopware.md#swdatabasemigrate) -* [sw:plugin:refresh](/docs/recipe/shopware.md#swpluginrefresh) -* [sw:theme:refresh](/docs/recipe/shopware.md#swthemerefresh) -* [sw:scheduled-task:register](/docs/recipe/shopware.md#swscheduled-taskregister) -* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear) -* [sw:plugin:update:all](/docs/recipe/shopware.md#swpluginupdateall) -* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear) +* [sw:database:migrate](/docs/recipe/shopware.md#sw-database-migrate) +* [sw:plugin:refresh](/docs/recipe/shopware.md#sw-plugin-refresh) +* [sw:theme:refresh](/docs/recipe/shopware.md#sw-theme-refresh) +* [sw:scheduled-task:register](/docs/recipe/shopware.md#sw-scheduled-task-register) +* [sw:cache:clear](/docs/recipe/shopware.md#sw-cache-clear) +* [sw:plugin:update:all](/docs/recipe/shopware.md#sw-plugin-update-all) +* [sw:cache:clear](/docs/recipe/shopware.md#sw-cache-clear) -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L145) Deploys your project. @@ -270,15 +270,15 @@ Deploys your project. This task is group task which contains next tasks: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) -* [sw:writable:jwt](/docs/recipe/shopware.md#swwritablejwt) -* [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#deploy-prepare) +* [sw:writable:jwt](/docs/recipe/shopware.md#sw-writable-jwt) +* [sw:deploy](/docs/recipe/shopware.md#sw-deploy) +* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deploy-clear_paths) +* [sw:cache:warmup](/docs/recipe/shopware.md#sw-cache-warmup) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) -### sw-build-without-db:get-remote-config +### sw-build-without-db:get-remote-config {#sw-build-without-db-get-remote-config} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L164) @@ -286,7 +286,7 @@ This task is group task which contains next tasks: -### sw-build-without-db:build +### sw-build-without-db:build {#sw-build-without-db-build} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L177) @@ -294,7 +294,7 @@ This task is group task which contains next tasks: -### sw-build-without-db +### sw-build-without-db {#sw-build-without-db} [Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L181) @@ -303,7 +303,7 @@ This task is group task which contains next tasks: This task is group task which contains next tasks: -* [sw-build-without-db:get-remote-config](/docs/recipe/shopware.md#sw-build-without-dbget-remote-config) -* [sw-build-without-db:build](/docs/recipe/shopware.md#sw-build-without-dbbuild) +* [sw-build-without-db:get-remote-config](/docs/recipe/shopware.md#sw-build-without-db-get-remote-config) +* [sw-build-without-db:build](/docs/recipe/shopware.md#sw-build-without-db-build) diff --git a/docs/recipe/silverstripe.md b/docs/recipe/silverstripe.md index 026756266..f0fc03879 100644 --- a/docs/recipe/silverstripe.md +++ b/docs/recipe/silverstripe.md @@ -28,22 +28,22 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Silverstripe** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [silverstripe:buildflush](/docs/recipe/silverstripe.md#silverstripebuildflush) – Runs /dev/build?flush=all -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [silverstripe:buildflush](/docs/recipe/silverstripe.md#silverstripe-buildflush) – Runs /dev/build?flush=all +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The silverstripe recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -104,7 +104,7 @@ The value of this configuration is autogenerated on access. ## Tasks -### silverstripe:build +### silverstripe:build {#silverstripe-build} [Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L48) Runs /dev/build. @@ -112,7 +112,7 @@ Runs /dev/build. Helper tasks -### silverstripe:buildflush +### silverstripe:buildflush {#silverstripe-buildflush} [Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L53) Runs /dev/build?flush=all. @@ -120,7 +120,7 @@ Runs /dev/build?flush=all. -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L61) Deploys your project. @@ -129,9 +129,9 @@ 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [silverstripe:buildflush](/docs/recipe/silverstripe.md#silverstripe-buildflush) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/spiral.md b/docs/recipe/spiral.md index 1cc64e987..dd5650b95 100644 --- a/docs/recipe/spiral.md +++ b/docs/recipe/spiral.md @@ -28,26 +28,26 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Spiral** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:environment](/docs/recipe/spiral.md#deployenvironment) – Create .env file if it doesn\'t exist -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [spiral:encrypt-key](/docs/recipe/spiral.md#spiralencrypt-key) – Generate new encryption key, if it doesn\'t exist -* [spiral:configure](/docs/recipe/spiral.md#spiralconfigure) – Configure project -* [deploy:download-rr](/docs/recipe/spiral.md#deploydownload-rr) – Download RoadRunner -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project -* [deploy:restart-rr](/docs/recipe/spiral.md#deployrestart-rr) – Restart RoadRunner +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:environment](/docs/recipe/spiral.md#deploy-environment) – Create .env file if it doesn\'t exist +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [spiral:encrypt-key](/docs/recipe/spiral.md#spiral-encrypt-key) – Generate new encryption key, if it doesn\'t exist +* [spiral:configure](/docs/recipe/spiral.md#spiral-configure) – Configure project +* [deploy:download-rr](/docs/recipe/spiral.md#deploy-download-rr) – Download RoadRunner +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project +* [deploy:restart-rr](/docs/recipe/spiral.md#deploy-restart-rr) – Restart RoadRunner The spiral recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -90,7 +90,7 @@ Path to the RoadRunner server ## Tasks -### deploy:environment +### deploy:environment {#deploy-environment} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L19) Create .env file if it doesn\'t exist. @@ -98,7 +98,7 @@ Create .env file if it doesn\'t exist. -### spiral:configure +### spiral:configure {#spiral-configure} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L61) Configure project. @@ -106,7 +106,7 @@ Configure project. Spiral Framework console commands -### spiral:cycle +### spiral:cycle {#spiral-cycle} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L64) Update (init) cycle schema from database and annotated classes. @@ -114,7 +114,7 @@ Update (init) cycle schema from database and annotated classes. -### spiral:migrate +### spiral:migrate {#spiral-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L67) Perform all outstanding migrations. @@ -122,7 +122,7 @@ Perform all outstanding migrations. -### spiral:update +### spiral:update {#spiral-update} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L70) Update project state. @@ -130,7 +130,7 @@ Update project state. -### spiral:cache:clean +### spiral:cache:clean {#spiral-cache-clean} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L73) Clean application runtime cache. @@ -138,7 +138,7 @@ Clean application runtime cache. -### spiral:i18n:reset +### spiral:i18n:reset {#spiral-i18n-reset} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L76) Reset translation cache. @@ -146,7 +146,7 @@ Reset translation cache. -### spiral:encrypt-key +### spiral:encrypt-key {#spiral-encrypt-key} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L79) Generate new encryption key, if it doesn\'t exist. @@ -154,7 +154,7 @@ Generate new encryption key, if it doesn\'t exist. -### spiral:views:compile +### spiral:views:compile {#spiral-views-compile} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L82) Warm-up view cache. @@ -162,7 +162,7 @@ Warm-up view cache. -### spiral:views:reset +### spiral:views:reset {#spiral-views-reset} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L85) Clear view cache. @@ -170,7 +170,7 @@ Clear view cache. -### cycle:migrate +### cycle:migrate {#cycle-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L91) Generate ORM schema migrations. @@ -178,7 +178,7 @@ Generate ORM schema migrations. Cycle ORM and migrations console commands -### cycle:render +### cycle:render {#cycle-render} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L94) Render available CycleORM schemas. @@ -186,7 +186,7 @@ Render available CycleORM schemas. -### cycle:sync +### cycle:sync {#cycle-sync} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L97) Sync Cycle ORM schema with database without intermediate migration (risk operation). @@ -194,7 +194,7 @@ Sync Cycle ORM schema with database without intermediate migration (risk operati -### migrate:init +### migrate:init {#migrate-init} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L100) Init migrations component (create migrations table). @@ -202,7 +202,7 @@ Init migrations component (create migrations table). -### migrate:replay +### migrate:replay {#migrate-replay} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L103) Replay (down, up) one or multiple migrations. @@ -210,7 +210,7 @@ Replay (down, up) one or multiple migrations. -### migrate:rollback +### migrate:rollback {#migrate-rollback} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L106) Rollback one (default) or multiple migrations. @@ -218,7 +218,7 @@ Rollback one (default) or multiple migrations. -### migrate:status +### migrate:status {#migrate-status} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L109) Get list of all available migrations and their statuses. @@ -226,7 +226,7 @@ Get list of all available migrations and their statuses. -### roadrunner:serve +### roadrunner:serve {#roadrunner-serve} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L115) Start RoadRunner server. @@ -234,7 +234,7 @@ Start RoadRunner server. RoadRunner console commands -### roadrunner:stop +### roadrunner:stop {#roadrunner-stop} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L120) Stop RoadRunner server. @@ -242,7 +242,7 @@ Stop RoadRunner server. -### roadrunner:reset +### roadrunner:reset {#roadrunner-reset} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L123) Reset workers of all services. @@ -250,7 +250,7 @@ Reset workers of all services. -### deploy:download-rr +### deploy:download-rr {#deploy-download-rr} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L129) Download RoadRunner. @@ -258,7 +258,7 @@ Download RoadRunner. Download and restart RoadRunner -### deploy:restart-rr +### deploy:restart-rr {#deploy-restart-rr} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L135) Restart RoadRunner. @@ -266,7 +266,7 @@ Restart RoadRunner. -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/spiral.php#L149) Deploys your project. @@ -275,13 +275,13 @@ Main task This task is group task which contains next tasks: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) -* [deploy:environment](/docs/recipe/spiral.md#deployenvironment) -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) -* [spiral:encrypt-key](/docs/recipe/spiral.md#spiralencrypt-key) -* [spiral:configure](/docs/recipe/spiral.md#spiralconfigure) -* [deploy:download-rr](/docs/recipe/spiral.md#deploydownload-rr) -* [deploy:publish](/docs/recipe/common.md#deploypublish) -* [deploy:restart-rr](/docs/recipe/spiral.md#deployrestart-rr) +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) +* [deploy:environment](/docs/recipe/spiral.md#deploy-environment) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [spiral:encrypt-key](/docs/recipe/spiral.md#spiral-encrypt-key) +* [spiral:configure](/docs/recipe/spiral.md#spiral-configure) +* [deploy:download-rr](/docs/recipe/spiral.md#deploy-download-rr) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) +* [deploy:restart-rr](/docs/recipe/spiral.md#deploy-restart-rr) diff --git a/docs/recipe/statamic.md b/docs/recipe/statamic.md index cbcbe63ce..7b9eddcb1 100644 --- a/docs/recipe/statamic.md +++ b/docs/recipe/statamic.md @@ -28,25 +28,25 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Statamic** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [artisan:storage:link](/docs/recipe/laravel.md#artisanstoragelink) – Creates the symbolic links configured for the application -* [artisan:cache:clear](/docs/recipe/laravel.md#artisancacheclear) – Flushes the application cache -* [statamic:stache:clear](/docs/recipe/statamic.md#statamicstacheclear) – Clears the "Stache" cache -* [statamic:stache:warm](/docs/recipe/statamic.md#statamicstachewarm) – Builds the "Stache" cache -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [artisan:storage:link](/docs/recipe/laravel.md#artisan-storage-link) – Creates the symbolic links configured for the application +* [artisan:cache:clear](/docs/recipe/laravel.md#artisan-cache-clear) – Flushes the application cache +* [statamic:stache:clear](/docs/recipe/statamic.md#statamic-stache-clear) – Clears the "Stache" cache +* [statamic:stache:warm](/docs/recipe/statamic.md#statamic-stache-warm) – Builds the "Stache" cache +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The statamic recipe is based on the [laravel](/docs/recipe/laravel.md) recipe. @@ -67,7 +67,7 @@ return $matches[0][0] ?? 'unknown'; ## Tasks -### statamic:addons:discover +### statamic:addons:discover {#statamic-addons-discover} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L27) Rebuilds the cached addon package manifest. @@ -75,7 +75,7 @@ Rebuilds the cached addon package manifest. Addons -### statamic:assets:generate-presets +### statamic:assets:generate-presets {#statamic-assets-generate-presets} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L34) Generates asset preset manipulations. @@ -83,7 +83,7 @@ Generates asset preset manipulations. Assets -### statamic:assets:meta +### statamic:assets:meta {#statamic-assets-meta} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L37) Generates asset metadata files. @@ -91,7 +91,7 @@ Generates asset metadata files. -### statamic:git:commit +### statamic:git:commit {#statamic-git-commit} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L44) Git add and commit tracked content. @@ -99,7 +99,7 @@ Git add and commit tracked content. Git -### statamic:glide:clear +### statamic:glide:clear {#statamic-glide-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L51) Clears the Glide image cache. @@ -107,7 +107,7 @@ Clears the Glide image cache. Glide -### statamic:responsive:generate +### statamic:responsive:generate {#statamic-responsive-generate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L58) Generates responsive images. @@ -115,7 +115,7 @@ Generates responsive images. Responsive Images (not in the core) -### statamic:responsive:regenerate +### statamic:responsive:regenerate {#statamic-responsive-regenerate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L61) Regenerate responsive images. @@ -123,7 +123,7 @@ Regenerate responsive images. -### statamic:search:insert +### statamic:search:insert {#statamic-search-insert} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L68) Inserts an item into its search indexes. @@ -131,7 +131,7 @@ Inserts an item into its search indexes. Search -### statamic:search:update +### statamic:search:update {#statamic-search-update} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L71) Update a search index. @@ -139,7 +139,7 @@ Update a search index. -### statamic:stache:clear +### statamic:stache:clear {#statamic-stache-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L78) Clears the "Stache" cache. @@ -147,7 +147,7 @@ Clears the "Stache" cache. Stache -### statamic:stache:doctor +### statamic:stache:doctor {#statamic-stache-doctor} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L81) Diagnose any problems with the Stache. @@ -155,7 +155,7 @@ Diagnose any problems with the Stache. -### statamic:stache:refresh +### statamic:stache:refresh {#statamic-stache-refresh} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L84) Clears and rebuild the "Stache" cache. @@ -163,7 +163,7 @@ Clears and rebuild the "Stache" cache. -### statamic:stache:warm +### statamic:stache:warm {#statamic-stache-warm} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L87) Builds the "Stache" cache. @@ -171,7 +171,7 @@ Builds the "Stache" cache. -### statamic:static:clear +### statamic:static:clear {#statamic-static-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L94) Clears the static page cache. @@ -179,7 +179,7 @@ Clears the static page cache. Static -### statamic:static:warm +### statamic:static:warm {#statamic-static-warm} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L97) Warms the static cache by visiting all URLs. @@ -187,7 +187,7 @@ Warms the static cache by visiting all URLs. -### statamic:support:details +### statamic:support:details {#statamic-support-details} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L104) Outputs details helpful for support requests. @@ -195,7 +195,7 @@ Outputs details helpful for support requests. Support -### statamic:updates:run +### statamic:updates:run {#statamic-updates-run} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L111) Runs update scripts from specific version. @@ -203,7 +203,7 @@ Runs update scripts from specific version. Updated -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/statamic.php#L119) Deploys your project. @@ -213,12 +213,12 @@ will overwrite the Laravel default. 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [artisan:storage:link](/docs/recipe/laravel.md#artisan-storage-link) +* [artisan:cache:clear](/docs/recipe/laravel.md#artisan-cache-clear) +* [statamic:stache:clear](/docs/recipe/statamic.md#statamic-stache-clear) +* [statamic:stache:warm](/docs/recipe/statamic.md#statamic-stache-warm) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/sulu.md b/docs/recipe/sulu.md index 44afc4fec..00cc62623 100644 --- a/docs/recipe/sulu.md +++ b/docs/recipe/sulu.md @@ -28,22 +28,22 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Sulu** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:cache:clear](/docs/recipe/symfony.md#deploycacheclear) – Clears cache -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:cache:clear](/docs/recipe/symfony.md#deploy-cache-clear) – Clears cache +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The sulu recipe is based on the [symfony](/docs/recipe/symfony.md) recipe. @@ -62,7 +62,7 @@ return parse('{{bin/php}} {{release_or_current_path}}/bin/websiteconsole --no-in ## Tasks -### phpcr:migrate +### phpcr:migrate {#phpcr-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/sulu.php#L18) Migrates PHPCR. @@ -70,7 +70,7 @@ Migrates PHPCR. -### deploy:website:cache:clear +### deploy:website:cache:clear {#deploy-website-cache-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/sulu.php#L23) Clears cache. @@ -78,7 +78,7 @@ Clears cache. -### deploy:website:cache:warmup +### deploy:website:cache:warmup {#deploy-website-cache-warmup} [Source](https://github.com/deployphp/deployer/blob/master/recipe/sulu.php#L28) Warmups cache. diff --git a/docs/recipe/symfony.md b/docs/recipe/symfony.md index e169ff439..21ebb3a6e 100644 --- a/docs/recipe/symfony.md +++ b/docs/recipe/symfony.md @@ -28,22 +28,22 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Symfony** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:cache:clear](/docs/recipe/symfony.md#deploycacheclear) – Clears cache -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:cache:clear](/docs/recipe/symfony.md#deploy-cache-clear) – Clears cache +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The symfony recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -153,7 +153,7 @@ return '--no-interaction'; ## Tasks -### database:migrate +### database:migrate {#database-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/symfony.php#L43) Migrates database. @@ -161,7 +161,7 @@ Migrates database. -### doctrine:schema:validate +### doctrine:schema:validate {#doctrine-schema-validate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/symfony.php#L53) Validate the Doctrine mapping files. @@ -169,7 +169,7 @@ Validate the Doctrine mapping files. -### deploy:cache:clear +### deploy:cache:clear {#deploy-cache-clear} [Source](https://github.com/deployphp/deployer/blob/master/recipe/symfony.php#L58) Clears cache. @@ -177,7 +177,7 @@ Clears cache. -### deploy:env +### deploy:env {#deploy-env} [Source](https://github.com/deployphp/deployer/blob/master/recipe/symfony.php#L67) Optimize environment variables. @@ -185,7 +185,7 @@ Optimize environment variables. -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/symfony.php#L74) Deploys project. @@ -194,9 +194,9 @@ Deploys project. 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:cache:clear](/docs/recipe/symfony.md#deploy-cache-clear) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/typo3.md b/docs/recipe/typo3.md index ebd8bdf92..54147fc26 100644 --- a/docs/recipe/typo3.md +++ b/docs/recipe/typo3.md @@ -28,21 +28,21 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **TYPO3** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The typo3 recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -108,7 +108,7 @@ Writeable directories ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/typo3.php#L18) Deploys your project. @@ -117,8 +117,8 @@ 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/wordpress.md b/docs/recipe/wordpress.md index 418d9b7c2..b82ca73af 100644 --- a/docs/recipe/wordpress.md +++ b/docs/recipe/wordpress.md @@ -28,20 +28,20 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **WordPress** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The wordpress recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -86,7 +86,7 @@ Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `r ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/wordpress.php#L14) Deploys your project. @@ -95,7 +95,7 @@ Deploys your project. 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#deploy-prepare) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/yii.md b/docs/recipe/yii.md index 1e9c97010..b35045e6b 100644 --- a/docs/recipe/yii.md +++ b/docs/recipe/yii.md @@ -28,22 +28,22 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Yii2** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:migrate](/docs/recipe/yii.md#deploymigrate) – Runs Yii2 migrations for your project -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:migrate](/docs/recipe/yii.md#deploy-migrate) – Runs Yii2 migrations for your project +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The yii recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -76,7 +76,7 @@ Yii writable dirs ## Tasks -### deploy:migrate +### deploy:migrate {#deploy-migrate} [Source](https://github.com/deployphp/deployer/blob/master/recipe/yii.php#L16) Runs Yii2 migrations for your project. @@ -84,7 +84,7 @@ Runs Yii2 migrations for your project. -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/yii.php#L24) Deploys your project. @@ -93,9 +93,9 @@ 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:migrate](/docs/recipe/yii.md#deploymigrate) -* [deploy:publish](/docs/recipe/common.md#deploypublish) +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:migrate](/docs/recipe/yii.md#deploy-migrate) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/docs/recipe/zend_framework.md b/docs/recipe/zend_framework.md index f57d1f10d..924b5eef0 100644 --- a/docs/recipe/zend_framework.md +++ b/docs/recipe/zend_framework.md @@ -28,21 +28,21 @@ Additionally, Deployer has a lot of other features, like: You can read more about Deployer in [Getting Started](/docs/getting-started.md). The [deploy](#deploy) task of **Zend Framework** consists of: -* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release - * [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment - * [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy - * [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy - * [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release - * [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code - * [deploy:env](/docs/recipe/symfony.md#deployenv) – Optimize environment variables - * [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs - * [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs -* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors -* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release - * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release - * [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy - * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases - * [deploy:success](/docs/recipe/common.md#deploysuccess) – Deploys your project +* [deploy:prepare](/docs/recipe/common.md#deploy-prepare) – Prepares a new release + * [deploy:info](/docs/recipe/deploy/info.md#deploy-info) – Displays info about deployment + * [deploy:setup](/docs/recipe/deploy/setup.md#deploy-setup) – Prepares host for deploy + * [deploy:lock](/docs/recipe/deploy/lock.md#deploy-lock) – Locks deploy + * [deploy:release](/docs/recipe/deploy/release.md#deploy-release) – Prepares release + * [deploy:update_code](/docs/recipe/deploy/update_code.md#deploy-update_code) – Updates code + * [deploy:env](/docs/recipe/symfony.md#deploy-env) – Optimize environment variables + * [deploy:shared](/docs/recipe/deploy/shared.md#deploy-shared) – Creates symlinks for shared files and dirs + * [deploy:writable](/docs/recipe/deploy/writable.md#deploy-writable) – Makes writable dirs +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) – Installs vendors +* [deploy:publish](/docs/recipe/common.md#deploy-publish) – Publishes the release + * [deploy:symlink](/docs/recipe/deploy/symlink.md#deploy-symlink) – Creates symlink to release + * [deploy:unlock](/docs/recipe/deploy/lock.md#deploy-unlock) – Unlocks deploy + * [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploy-cleanup) – Cleanup old releases + * [deploy:success](/docs/recipe/common.md#deploy-success) – Deploys your project The zend_framework recipe is based on the [common](/docs/recipe/common.md) recipe. @@ -50,7 +50,7 @@ The zend_framework recipe is based on the [common](/docs/recipe/common.md) recip ## Tasks -### deploy +### deploy {#deploy} [Source](https://github.com/deployphp/deployer/blob/master/recipe/zend_framework.php#L13) Deploys your project. @@ -59,8 +59,8 @@ 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#deploy-prepare) +* [deploy:vendors](/docs/recipe/deploy/vendors.md#deploy-vendors) +* [deploy:publish](/docs/recipe/common.md#deploy-publish) diff --git a/src/Documentation/DocGen.php b/src/Documentation/DocGen.php index 0e8ee636a..93101e291 100644 --- a/src/Documentation/DocGen.php +++ b/src/Documentation/DocGen.php @@ -274,7 +274,8 @@ public function gen(string $destination): ?string if (count($recipe->tasks) > 0) { $tasks .= "## Tasks\n\n"; foreach ($recipe->tasks as $t) { - $tasks .= "### {$t->name}\n"; + $anchorTag = '{#' . anchor($t->name) . '}'; + $tasks .= "### {$t->name} $anchorTag\n"; $tasks .= "[Source](https://github.com/deployphp/deployer/blob/master/{$t->recipePath}#L{$t->lineNumber})\n\n"; $tasks .= add_tailing_dot($t->desc) . "\n\n"; $tasks .= $replaceLinks($t->comment); @@ -368,7 +369,7 @@ function php_to_md(string $file): string function anchor(string $s): string { - return strtolower(str_replace(':', '', $s)); + return strtolower(str_replace(':', '-', $s)); } function remove_text_emoji(string $text): string