Skip to content

Commit b40c641

Browse files
committed
Refactor shopware recipe
1 parent a806757 commit b40c641

File tree

2 files changed

+170
-225
lines changed

2 files changed

+170
-225
lines changed

docs/recipe/shopware.md

Lines changed: 64 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,41 @@
1212
* [common](/docs/recipe/common.md)
1313

1414
## Configuration
15-
### release_name
16-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L15)
15+
### default_timeout
16+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L23)
1717

18-
Overrides [release_name](/docs/recipe/deploy/release.md#release_name) from `recipe/deploy/release.php`.
18+
Overrides [default_timeout](/docs/recipe/common.md#default_timeout) from `recipe/common.php`.
1919

2020

2121

2222

2323

2424
### shared_files
25-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L19)
25+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L26)
2626

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

29-
29+
These files are shared among all releases.
3030

3131
```php title="Default value"
3232
[
3333
'.env',
34+
'install.lock',
35+
'public/.htaccess',
36+
'public/.user.ini',
3437
]
3538
```
3639

3740

3841
### shared_dirs
39-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L22)
42+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L34)
4043

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

43-
46+
These directories are shared among all releases.
4447

4548
```php title="Default value"
4649
[
47-
'custom/plugins',
4850
'config/jwt',
4951
'files',
5052
'var/log',
@@ -56,160 +58,143 @@ Overrides [shared_dirs](/docs/recipe/deploy/shared.md#shared_dirs) from `recipe/
5658

5759

5860
### writable_dirs
59-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L31)
61+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L45)
6062

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

63-
65+
These directories are made writable (the definition of "writable" requires attention).
66+
Please note that the files in `config/jwt/*` receive special attention in the `sw:writable:jwt` task.
6467

6568
```php title="Default value"
6669
[
70+
'config/jwt',
6771
'custom/plugins',
6872
'files',
69-
'var',
73+
'press_files',
74+
'public/bundles',
75+
'public/css',
76+
'public/fonts',
77+
'public/js',
7078
'public/media',
71-
'public/thumbnail',
7279
'public/sitemap',
80+
'public/theme',
81+
'public/thumbnail',
82+
'var',
7383
]
7484
```
7585

7686

77-
### static_folders
78-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L39)
79-
80-
81-
82-
83-
8487

8588
## Tasks
8689

87-
### sw:update_code
88-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L41)
89-
90-
91-
92-
93-
94-
95-
### sw:system:install
96-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L44)
97-
98-
99-
100-
101-
102-
103-
### sw:build
104-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L47)
105-
90+
### sw:cache:clear
91+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L62)
10692

10793

10894

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

11097

111-
### sw:system:setup
112-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L50)
98+
### sw:cache:warmup
99+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L68)
113100

114101

115102

103+
This task remotely executes the cache warmup console commands on the target server, so that the first user, who
104+
visits the website, doesn't have to wait for the cache to be built up.
116105

117106

107+
### sw:database:migrate
108+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L74)
118109

119-
### sw:theme:compile
120-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L53)
121110

122111

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

124114

115+
### sw:plugin:refresh
116+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L78)
125117

126118

127-
### sw:cache:clear
128-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L56)
129119

130120

131121

132122

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

134126

135-
### sw:cache:warmup
136-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L59)
137127

138128

139129

140130

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

142134

143-
### sw:database:migrate
144-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L63)
145135

146136

147137

148138

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

150142

151-
### sw:plugin:refresh
152-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L66)
153143

144+
Grouped SW deploy tasks.
154145

155146

147+
This task is group task which contains next tasks:
148+
* [sw:database:migrate](/docs/recipe/shopware.md#swdatabasemigrate)
149+
* [sw:plugin:refresh](/docs/recipe/shopware.md#swpluginrefresh)
150+
* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear)
151+
* [sw:plugin:update:all](/docs/recipe/shopware.md#swpluginupdateall)
152+
* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear)
156153

157154

155+
### deploy
156+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L140)
158157

159-
### sw:plugin:activate:all
160-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L129)
158+
Deploy your project.
161159

162160

163161

164162

163+
This task is group task which contains next tasks:
164+
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
165+
* [sw:deploy](/docs/recipe/shopware.md#swdeploy)
166+
* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deployclear_paths)
167+
* [sw:cache:warmup](/docs/recipe/shopware.md#swcachewarmup)
168+
* [sw:writable:jwt](/docs/recipe/shopware.md#swwritablejwt)
169+
* [deploy:publish](/docs/recipe/common.md#deploypublish)
165170

166171

167-
### sw:plugin:migrate:all
172+
### sw-build-without-db:get-remote-config
168173
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L150)
169174

170175

171176

172177

173178

174179

175-
### sw:plugin:upgrade:all
176-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L170)
180+
### sw-build-without-db:build
181+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L163)
177182

178183

179184

180185

181186

182187

183-
### sw:deploy
184-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L193)
185-
186-
187-
188-
Grouped SW deploy tasks
189-
190-
191-
This task is group task which contains next tasks:
192-
* [sw:plugin:activate:all](/docs/recipe/shopware.md#swpluginactivateall)
193-
* [sw:database:migrate](/docs/recipe/shopware.md#swdatabasemigrate)
194-
* [sw:plugin:migrate:all](/docs/recipe/shopware.md#swpluginmigrateall)
195-
* [sw:build](/docs/recipe/shopware.md#swbuild)
196-
* [sw:theme:compile](/docs/recipe/shopware.md#swthemecompile)
197-
* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear)
188+
### sw-build-without-db
189+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L167)
198190

199191

200-
### deploy
201-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L206)
202192

203-
Deploy your project.
204193

205-
Main task
206194

207195

208196
This task is group task which contains next tasks:
209-
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
210-
* [sw:deploy](/docs/recipe/shopware.md#swdeploy)
211-
* [deploy:clear_paths](/docs/recipe/deploy/clear_paths.md#deployclear_paths)
212-
* [sw:cache:warmup](/docs/recipe/shopware.md#swcachewarmup)
213-
* [deploy:publish](/docs/recipe/common.md#deploypublish)
197+
* [sw-build-without-db:get-remote-config](/docs/recipe/shopware.md#sw-build-without-dbget-remote-config)
198+
* [sw-build-without-db:build](/docs/recipe/shopware.md#sw-build-without-dbbuild)
214199

215200

0 commit comments

Comments
 (0)