Skip to content

Commit 8bdd587

Browse files
github-actions[bot]github-actions[bot]
committed
[automatic] Update docs with bin/docgen
1 parent 8576688 commit 8bdd587

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

‎docs/recipe/shopware.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ configure host:
7070
```php
7171
host('SSH-HOSTNAME')
7272
->set('remote_user', 'SSH-USER')
73-
->set('deploy_path', '/var/www/shopware') // This is the path, where deployer will create its directory structure
74-
->set('http_user', 'www-data') // Not needed, if the `user` is the same user, the webserver is running with
73+
->set('deploy_path', '/var/www/shopware') // This is the path where deployer will create its directory structure
74+
->set('http_user', 'www-data') // Not needed, if the `user` is the same, the web server is running with
7575
->set('http_group', 'www-data')
7676
->set('writable_mode', 'chmod')
7777
->set('writable_recursive', true)
@@ -134,14 +134,15 @@ These directories are shared among all releases.
134134
'files',
135135
'var/log',
136136
'public/media',
137+
'public/plugins'
137138
'public/thumbnail',
138139
'public/sitemap',
139140
]
140141
```
141142

142143

143144
### writable_dirs
144-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L59)
145+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L60)
145146

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

@@ -158,6 +159,7 @@ Please note that the files in `config/jwt/*` receive special attention in the `s
158159
'public/fonts',
159160
'public/js',
160161
'public/media',
162+
'public/plugins'
161163
'public/sitemap',
162164
'public/theme',
163165
'public/thumbnail',
@@ -167,9 +169,9 @@ Please note that the files in `config/jwt/*` receive special attention in the `s
167169

168170

169171
### shopware_version
170-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L75)
172+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L77)
171173

172-
This sets the shopware version to the version of the shopware console command.
174+
This sets the Shopware version to the version of the Shopware console command.
173175

174176
```php title="Default value"
175177
$versionOutput = run('cd {{release_path}} && {{bin/console}} -V');
@@ -182,15 +184,15 @@ return $matches[0] ?? '6.6.0';
182184
## Tasks
183185

184186
### sw\:cache\:clear {#sw-cache-clear}
185-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L82)
187+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L84)
186188

187189

188190

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

191193

192194
### sw\:cache\:warmup {#sw-cache-warmup}
193-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L88)
195+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L90)
194196

195197

196198

@@ -199,64 +201,64 @@ visits the website, doesn't have to wait for the cache to be built up.
199201

200202

201203
### sw\:database\:migrate {#sw-database-migrate}
202-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L98)
204+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L100)
203205

204206

205207

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

208210

209211
### sw\:plugin\:refresh {#sw-plugin-refresh}
210-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L102)
212+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L104)
211213

212214

213215

214216

215217

216218

217219
### sw\:scheduled-task\:register {#sw-scheduled-task-register}
218-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L106)
220+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L108)
219221

220222

221223

222224

223225

224226

225227
### sw\:theme\:refresh {#sw-theme-refresh}
226-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L110)
228+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L112)
227229

228230

229231

230232

231233

232234

233235
### sw\:theme\:compile {#sw-theme-compile}
234-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L116)
236+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L118)
235237

236238

237239

238-
This task is not used per default, but can be used, e.g. in combination with `SHOPWARE_SKIP_THEME_COMPILE=1`,
240+
This task is not used by default, but can be used, e.g. in combination with `SHOPWARE_SKIP_THEME_COMPILE=1`,
239241
to build the theme remotely instead of locally.
240242

241243

242244
### sw\:plugin\:update\:all {#sw-plugin-update-all}
243-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L128)
245+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L130)
244246

245247

246248

247249

248250

249251

250252
### sw\:writable\:jwt {#sw-writable-jwt}
251-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L138)
253+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L140)
252254

253255

254256

255257

256258

257259

258260
### sw\:deploy {#sw-deploy}
259-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L148)
261+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L150)
260262

261263

262264

@@ -274,7 +276,7 @@ This task is group task which contains next tasks:
274276

275277

276278
### deploy {#deploy}
277-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L159)
279+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L161)
278280

279281
Deploys your project.
280282

@@ -291,23 +293,23 @@ This task is group task which contains next tasks:
291293

292294

293295
### sw-build-without-db\:get-remote-config {#sw-build-without-db-get-remote-config}
294-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L178)
296+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L180)
295297

296298

297299

298300

299301

300302

301303
### sw-build-without-db\:build {#sw-build-without-db-build}
302-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L191)
304+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L193)
303305

304306

305307

306308

307309

308310

309311
### sw-build-without-db {#sw-build-without-db}
310-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L195)
312+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L197)
311313

312314

313315

0 commit comments

Comments
 (0)