Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sprankhub committed Sep 5, 2024
1 parent 1af675b commit 2d28f4e
Show file tree
Hide file tree
Showing 24 changed files with 49 additions and 51 deletions.
2 changes: 1 addition & 1 deletion docs/recipe/cakephp.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Cakephp** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/codeigniter.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Codeigniter** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/codeigniter4.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Codeigniter 4** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/contao.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Contao** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/craftcms.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Craftcms** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/drupal7.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Drupal 7** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/drupal8.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Drupal 8** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/flow_framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Flow Framework** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/fuelphp.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Fuelphp** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/joomla.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Joomla** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/laravel.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Laravel** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/magento.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Magento** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
54 changes: 26 additions & 28 deletions docs/recipe/magento2.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Magento 2** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand All @@ -46,7 +46,6 @@ The [deploy](#deploy) task of **Magento 2** consists of:
* [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
* [magento:cache:flush](/docs/recipe/magento2.md#magentocacheflush) – Flushes Magento 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
Expand Down Expand Up @@ -353,7 +352,7 @@ true


### artifact_file
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L345)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L346)

The file the artifact is saved to

Expand All @@ -363,7 +362,7 @@ The file the artifact is saved to


### artifact_dir
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L348)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L349)

The directory the artifact is saved in

Expand All @@ -373,7 +372,7 @@ The directory the artifact is saved in


### artifact_excludes_file
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L352)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L353)

Points to a file with a list of files to exclude from packaging.
The format is as with the `tar --exclude-from=[file]` option
Expand All @@ -384,7 +383,7 @@ The format is as with the `tar --exclude-from=[file]` option


### build_from_repo
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L355)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L356)

If set to true, the artifact is built from a clean copy of the project repository instead of the current working directory

Expand All @@ -394,7 +393,7 @@ false


### repository
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L358)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L359)

Overrides [repository](/docs/recipe/common.md#repository) from `recipe/common.php`.

Expand All @@ -406,7 +405,7 @@ null


### artifact_path
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L361)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L362)

The relative path to the artifact file. If the directory does not exist, it will be created

Expand All @@ -419,7 +418,7 @@ return get('artifact_dir') . '/' . get('artifact_file');


### bin/tar
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L369)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L370)

The location of the tar command. On MacOS you should have installed gtar, as it supports the required settings
:::info Autogenerated
Expand All @@ -430,14 +429,14 @@ The value of this configuration is autogenerated on access.


### additional_shared_files
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L441)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L442)

Array of shared files that will be added to the default shared_files without overriding



### additional_shared_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L443)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L444)

Array of shared directories that will be added to the default shared_dirs without overriding

Expand Down Expand Up @@ -571,11 +570,10 @@ This task is group task which contains next tasks:
* [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:cache:flush](/docs/recipe/magento2.md#magentocacheflush)


### magento:build
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L326)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L325)

Magento2 build operations.

Expand All @@ -588,7 +586,7 @@ This task is group task which contains next tasks:


### deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L332)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L331)

Deploys your project.

Expand All @@ -604,47 +602,47 @@ This task is group task which contains next tasks:


### artifact:package
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L380)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L381)

Packages all relevant files in an artifact.




### artifact:upload
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L390)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L391)

Uploads artifact in release folder for extraction.




### artifact:extract
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L395)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L396)

Extracts artifact in release path.




### build:remove-generated
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L401)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L402)

Clears generated files prior to building.




### build:prepare
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L406)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L407)

Prepare local artifact build.




### artifact:build
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L431)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L432)

Builds an artifact.

Expand All @@ -661,15 +659,15 @@ This task is group task which contains next tasks:


### deploy:additional-shared
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L447)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L448)

Adds additional files and dirs to the list of shared files and dirs.




### magento:set_cache_prefix
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L462)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L463)

Update cache id_prefix.

Expand All @@ -683,15 +681,15 @@ after('deploy:magento', 'magento:cleanup_cache_prefix');


### magento:cleanup_cache_prefix
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L502)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L503)

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
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L518)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L519)

Remove cron from crontab and kill running cron jobs.

Expand All @@ -703,7 +701,7 @@ To use this feature, add the following to your deployer scripts:


### magento:cron:install
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L534)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L535)

Install cron in crontab.

Expand All @@ -715,7 +713,7 @@ To use this feature, add the following to your deployer scripts:


### artifact:prepare
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L540)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L541)

Prepares an artifact on the target server.

Expand All @@ -735,7 +733,7 @@ This task is group task which contains next tasks:


### artifact:finish
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L553)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L554)

Executes the tasks after artifact is released.

Expand All @@ -750,7 +748,7 @@ This task is group task which contains next tasks:


### artifact:deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L562)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L563)

Actually releases the artifact deployment.

Expand Down
2 changes: 1 addition & 1 deletion docs/recipe/pimcore.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Pimcore** consists of:
* [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/shopware.md#deployupdate_code)
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code)Updates code
* [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
Expand Down
Loading

0 comments on commit 2d28f4e

Please sign in to comment.