Skip to content

Commit baeb41e

Browse files
committed
[automatic] Update docs with bin/docgen
1 parent 4f51aa1 commit baeb41e

File tree

1 file changed

+18
-26
lines changed

1 file changed

+18
-26
lines changed

docs/recipe/common.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,8 @@ otherwise output of `whoami` command.
3636

3737

3838

39-
### remote_user
40-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L49)
41-
42-
Name of remote user used for SSH connection.
43-
Usually overridden per host. Otherwise, output of `whoami` will be used.
44-
45-
46-
4739
### keep_releases
48-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L54)
40+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L48)
4941

5042
Number of releases to preserve in releases folder.
5143

@@ -55,14 +47,14 @@ Number of releases to preserve in releases folder.
5547

5648

5749
### repository
58-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L57)
50+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L51)
5951

6052
Repository to deploy.
6153

6254

6355

6456
### default_timeout
65-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L62)
57+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L56)
6658

6759
Default timeout for `run()` and `runLocally()` functions.
6860

@@ -74,7 +66,7 @@ Set to `null` to disable timeout.
7466

7567

7668
### env
77-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L78)
69+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L72)
7870

7971
Remote environment variables.
8072
```php
@@ -92,7 +84,7 @@ run('echo $KEY', env: ['KEY' => 'over']);
9284

9385

9486
### dotenv
95-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L87)
87+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L81)
9688

9789
Path to `.env` file which will be used as environment variables for each command per `run()`.
9890

@@ -106,7 +98,7 @@ false
10698

10799

108100
### deploy_path
109-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L97)
101+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L91)
110102

111103
The deploy path.
112104

@@ -118,7 +110,7 @@ set('deploy_path', '~/{{alias}}');
118110

119111

120112
### current_path
121-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L107)
113+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L101)
122114

123115
Return current release path. Default to [deploy_path](/docs/recipe/common.md#deploy_path)/`current`.
124116
```php
@@ -131,36 +123,36 @@ set('current_path', '/var/public_html');
131123

132124

133125
### bin/php
134-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L110)
126+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L104)
135127

136128
Path to the `php` bin.
137129

138130

139131

140132
### bin/git
141-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L118)
133+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L112)
142134

143135
Path to the `git` bin.
144136

145137

146138

147139
### use_relative_symlink
148-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L124)
140+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L118)
149141

150142
Should [bin/symlink](/docs/recipe/common.md#bin/symlink) use `--relative` option or not. Will detect
151143
automatically.
152144

153145

154146

155147
### bin/symlink
156-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L129)
148+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L123)
157149

158150
Path to the `ln` bin. With predefined options `-nfs`.
159151

160152

161153

162154
### sudo_askpass
163-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L136)
155+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L130)
164156

165157
Path to a file which will store temp script with sudo password.
166158
Defaults to `.dep/sudo_pass`. This script is only temporary and will be deleted after
@@ -169,7 +161,7 @@ sudo command executed.
169161

170162

171163
### target
172-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L149)
164+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L143)
173165

174166
The deploy target: a branch, a tag or a revision.
175167

@@ -179,7 +171,7 @@ The deploy target: a branch, a tag or a revision.
179171
## Tasks
180172

181173
### deploy:prepare
182-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L168)
174+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L162)
183175

184176
Prepare a new release.
185177

@@ -197,7 +189,7 @@ This task is group task which contains next tasks:
197189

198190

199191
### deploy:publish
200-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L179)
192+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L173)
201193

202194
Publish the release.
203195

@@ -212,23 +204,23 @@ This task is group task which contains next tasks:
212204

213205

214206
### deploy:success
215-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L189)
207+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L183)
216208

217209

218210

219211
Prints success message
220212

221213

222214
### deploy:failed
223-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L199)
215+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L193)
224216

225217

226218

227219
Hook on deploy failure.
228220

229221

230222
### logs:app
231-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L208)
223+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/common.php#L202)
232224

233225
Show application logs.
234226

0 commit comments

Comments
 (0)