mirror of
https://github.com/deployphp/deployer.git
synced 2025-02-24 09:12:51 +01:00
8cf68ee2c3
In the "Upgrade from 4.x to 5.x," section, previously, the suggested mapping for `server($name, $hostname)` to `host($hostname)` silently dropped the $name, which will not retain the same command line calling argument. There's no need to drop the $name, moving from 4.x to 5.x just changes the way it's declared. So this PR adds more precise suggested mapping, so that users will have smoother transition when upgrading.
163 lines
4.0 KiB
Markdown
163 lines
4.0 KiB
Markdown
# Upgrade from 5.x to 6.x
|
|
|
|
1. Changed branch option priority
|
|
|
|
If you have host definition with `branch(...)` parameter, adding `--branch` option will not override it any more.
|
|
If no `branch(...)` parameter persists, branch will be fetched from current local git branch.
|
|
|
|
```php
|
|
host('prod')
|
|
->set('branch', 'production')
|
|
```
|
|
|
|
In order to return to old behavior add checking of `--branch` option.
|
|
|
|
```php
|
|
host('prod')
|
|
->set('branch', function () {
|
|
return input()->getOption('branch') ?: 'production';
|
|
})
|
|
```
|
|
|
|
2. Add `deploy:info` task to the beginning to `deploy` task.
|
|
|
|
3. `run` returns string instead of `Deployer\Type\Result`
|
|
|
|
Now `run` and `runLocally` returns `string` instead of `Deployer\Type\Result`.
|
|
Replace method calls as:
|
|
|
|
* `run('command')->toString()` → `run('command')`
|
|
* `run('if command; then echo "true"; fi;')->toBool()` → `test('command')`
|
|
|
|
4. `env_vars` renamed to `env`
|
|
|
|
* `set('env_vars', 'FOO=bar');` → `set('env', ['FOO' => 'bar']);`
|
|
|
|
If your are using Symfony recipe, then you need to change `env` setting:
|
|
|
|
* `set('env', 'prod');` → `set('symfony_env', 'prod');`
|
|
|
|
# Upgrade from 4.x to 5.x
|
|
|
|
1. Servers to Hosts
|
|
|
|
* `server($hostname)` to `host($hostname)`, and `server($name, $hostname)` to `host($name)->hostname($hostname)`
|
|
* `localServer($name)` to `localhost()`
|
|
* `cluster($name, $nodes, $port)` to `hosts(...$hodes)`
|
|
* `serverList($file)` to `inventory($file)`
|
|
|
|
If you need to deploy to same server use [host aliases](https://deployer.org/docs/hosts#host-aliases):
|
|
|
|
```php
|
|
host('domain.com/green', 'domain.com/blue')
|
|
->set('deploy_path', '~/{{hostname}}')
|
|
...
|
|
```
|
|
|
|
Or you can define different hosts with same hostname:
|
|
|
|
```php
|
|
host('production')
|
|
->hostname('domain.com')
|
|
->set('deploy_path', '~/production')
|
|
...
|
|
|
|
host('beta')
|
|
->hostname('domain.com')
|
|
->set('deploy_path', '~/beta')
|
|
...
|
|
```
|
|
|
|
2. Configuration options
|
|
|
|
* Rename `{{server.name}}` to `{{hostname}}`
|
|
|
|
3. DotArray syntax
|
|
|
|
In v5 access to nested arrays in config via dot notation was removed.
|
|
If you was using it, consider to move to plain config options.
|
|
|
|
Refactor this:
|
|
|
|
```php
|
|
set('a', ['b' => 1]);
|
|
|
|
// ...
|
|
|
|
get('a.b');
|
|
```
|
|
|
|
To:
|
|
|
|
```php
|
|
set('a_b', 1);
|
|
|
|
// ...
|
|
|
|
get('a_b');
|
|
```
|
|
|
|
4. Credentials
|
|
|
|
Best practice in new v5 is to omit credentials for connection in `deploy.php` and write them in `~/.ssh/config` instead.
|
|
|
|
* `identityFile($publicKeyFile,, $privateKeyFile, $passPhrase)` to `identityFile($privateKeyFile)`
|
|
* `pemFile($pemFile)` to `identityFile($pemFile)`
|
|
* `forwardAgent()` to `forwardAgent(true)`
|
|
|
|
5. Tasks constraints
|
|
|
|
* `onlyOn` to `onHosts`
|
|
* `onlyOnStage` to `onStage`
|
|
|
|
|
|
# Upgrade from 3.x to 4.x
|
|
|
|
1. Namespace for functions
|
|
|
|
Add to beginning of *deploy.php* next line:
|
|
|
|
```php
|
|
use function Deployer\{server, task, run, set, get, add, before, after};
|
|
```
|
|
|
|
If you are using PHP version less than 5.6, you can use this:
|
|
|
|
```php
|
|
namespace Deployer;
|
|
```
|
|
|
|
2. `env()` to `set()`/`get()`
|
|
|
|
Rename all calls `env($name, $value)` to `set($name, $value)`.
|
|
|
|
Rename all rvalue `env($name)` to `get($name)`.
|
|
|
|
Rename all `server(...)->env(...)` to `server(...)->set(...)`.
|
|
|
|
3. Moved *NonFatalException*
|
|
|
|
Rename `Deployer\Task\NonFatalException` to `Deployer\Exception\NonFatalException`.
|
|
|
|
4. Prior release cleanup
|
|
|
|
Due to changes in release management, the new cleanup task will ignore any prior releases deployed with 3.x. These will need to be manually removed after migrating to and successfully releasing via 4.x.
|
|
|
|
# Upgrade from 2.x to 3.x
|
|
|
|
1. ### `->path('...')`
|
|
|
|
Replace your server paths configuration:
|
|
|
|
```php
|
|
server(...)
|
|
->path(...);
|
|
```
|
|
|
|
to:
|
|
|
|
```php
|
|
server(...)
|
|
->env('deploy_path', '...');
|
|
```
|