Skip to content

Commit cf359ab

Browse files
authored
Update UPGRADE.md
1 parent 659669c commit cf359ab

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/UPGRADE.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Upgrade from 6.x to 7.x
22

3-
## Step 1: Update `deploy.php`
4-
1. Change `hostname` to `alias`.
5-
2. Change `real_hostname` to `hostname`.
6-
3. Change `user` to `remote_user`.
3+
## Step 1: Update deploy.php
4+
1. Change config `hostname` to `alias`.
5+
2. Change config `real_hostname` to `hostname`.
6+
3. Change config `user` to `remote_user`.
77
4. Update `host()` definitions:
88
1. Add `set` prefix to all setters: `identityFile` -> `setIdentityFile` or `set('identify_file')`
99
2. Update `host(...)->addSshOption('UserKnownHostsFile', '/dev/null')` to `host(...)->setSshArguments(['-o UserKnownHostsFile=/dev/null']);`
@@ -12,7 +12,7 @@
1212
host('deployer.org')
1313
->set('labels', ['stage' => 'prod']);
1414
```
15-
When deploying use instead of `vendor/bin/dep deploy prod` now `vendor/bin/dep deploy stage=prod`.
15+
When deploying use instead of `dep deploy prod` use `dep deploy stage=prod`.
1616
4. `alias()` is deleted, `host()` itself sets alias and hostname, to override hostname use `setHostname()`.
1717
5. Update `task()` definitions.
1818
1. Replace `onRoles()` with `select()`:
@@ -53,7 +53,7 @@
5353
deploy:vendors:
5454
- run: 'cd {{release_path}} && echo {{bin/composer}} {{composer_options}} 2>&1'
5555
```
56-
8. Rename success task in ~~success~~ to `deploy:success`.
56+
8. Rename task `success` to `deploy:success`.
5757
9. Verbosity function (`isDebug()`, etc) deleted. Use `output()->isDebug()` instead.
5858
10. runLocally() commands are executed relative to the recipe file directory. This behaviour can be overridden via an environment variable:
5959
```bash
@@ -71,12 +71,13 @@ Since the release history numbering is not compatible between v6 and v7, you nee
7171
```
7272
dep deploy -o release_name=43
7373
```
74-
> **Note**
75-
>
76-
> In case a rollback is needed, manually change the `current` symlink:
77-
> ```
78-
> ln -nfs releases/42 current
79-
> ```
74+
75+
:::note
76+
In case a rollback is needed, manually change the `current` symlink:
77+
```
78+
ln -nfs releases/42 current
79+
```
80+
:::
8081

8182

8283
## Other versions

0 commit comments

Comments
 (0)