Skip to content

Commit

Permalink
docs(recipe/shopware): add code syntax highlighting (#3834)
Browse files Browse the repository at this point in the history
  • Loading branch information
SimJoSt authored May 18, 2024
1 parent 1d3c166 commit 3db79c6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 30 deletions.
52 changes: 23 additions & 29 deletions docs/recipe/shopware.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [deploy](#deploy) task of **Shopware** 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
* [sw:deploy](/docs/recipe/shopware.md#swdeploy)
Expand All @@ -59,13 +59,14 @@ The shopware recipe is based on the [common](/docs/recipe/common.md) recipe.

## Usage

Add {{repository}} to your _deploy.php_ file:
Add `repository` to your _deploy.php_ file:

```php
set('repository', '[email protected]:shopware/production.git');
```

configure host:
```php
host('SSH-HOSTNAME')
->set('remote_user', 'SSH-USER')
->set('deploy_path', '/var/www/shopware') // This is the path, where deployer will create its directory structure
Expand All @@ -74,6 +75,7 @@ host('SSH-HOSTNAME')
->set('writable_mode', 'chmod')
->set('writable_recursive', true)
->set('become', 'www-data'); // You might want to change user to execute remote tasks because of access rights of created cache files
```

:::note
Please remember that the installation must be modified so that it can be
Expand All @@ -83,7 +85,7 @@ Please remember that the installation must be modified so that it can be

## Configuration
### bin/console
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L32)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L34)



Expand All @@ -93,7 +95,7 @@ Please remember that the installation must be modified so that it can be


### default_timeout
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L34)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L36)

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

Expand All @@ -102,7 +104,7 @@ Overrides [default_timeout](/docs/recipe/common.md#default_timeout) from `recipe


### shared_files
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L37)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L39)

Overrides [shared_files](/docs/recipe/deploy/shared.md#shared_files) from `recipe/deploy/shared.php`.

Expand All @@ -119,7 +121,7 @@ These files are shared among all releases.


### shared_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L45)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L47)

Overrides [shared_dirs](/docs/recipe/deploy/shared.md#shared_dirs) from `recipe/deploy/shared.php`.

Expand All @@ -138,7 +140,7 @@ These directories are shared among all releases.


### writable_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L56)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L58)

Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`.

Expand Down Expand Up @@ -167,15 +169,15 @@ Please note that the files in `config/jwt/*` receive special attention in the `s
## Tasks

### sw:cache:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L72)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L74)



This task remotely executes the `cache:clear` console command on the target server.


### sw:cache:warmup
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L78)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L80)



Expand All @@ -184,39 +186,39 @@ visits the website, doesn't have to wait for the cache to be built up.


### sw:database:migrate
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L84)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L86)



This task remotely executes the `database:migrate` console command on the target server.


### sw:plugin:refresh
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L88)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L90)






### sw:scheduled-task:register
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L92)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L94)






### sw:theme:refresh
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L96)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L98)






### sw:theme:compile
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L102)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L104)



Expand All @@ -225,23 +227,23 @@ to build the theme remotely instead of locally.


### sw:plugin:update:all
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L114)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L116)






### sw:writable:jwt
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L124)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L126)






### sw:deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L131)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L133)



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


### deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L142)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L144)

Deploys your project.

Expand All @@ -275,32 +277,24 @@ This task is group task which contains next tasks:
* [deploy:publish](/docs/recipe/common.md#deploypublish)


### deploy:update_code
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L151)






### sw-build-without-db:get-remote-config
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L161)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L153)






### sw-build-without-db:build
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L174)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L166)






### sw-build-without-db
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L178)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L170)



Expand Down
4 changes: 3 additions & 1 deletion recipe/shopware.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@
/**
* ## Usage
*
* Add {{repository}} to your _deploy.php_ file:
* Add `repository` to your _deploy.php_ file:
*
* ```php
* set('repository', '[email protected]:shopware/production.git');
* ```
*
* configure host:
* ```php
* host('SSH-HOSTNAME')
* ->set('remote_user', 'SSH-USER')
* ->set('deploy_path', '/var/www/shopware') // This is the path, where deployer will create its directory structure
Expand All @@ -17,6 +18,7 @@
* ->set('writable_mode', 'chmod')
* ->set('writable_recursive', true)
* ->set('become', 'www-data'); // You might want to change user to execute remote tasks because of access rights of created cache files
* ```
*
* :::note
* Please remember that the installation must be modified so that it can be
Expand Down

0 comments on commit 3db79c6

Please sign in to comment.