mirror of
https://github.com/deployphp/deployer.git
synced 2025-01-17 21:48:58 +01:00
Replace ``bash with
``
This commit is contained in:
parent
cf359ab027
commit
55879f95ee
@ -56,7 +56,7 @@
|
||||
8. Rename task `success` to `deploy:success`.
|
||||
9. Verbosity function (`isDebug()`, etc) deleted. Use `output()->isDebug()` instead.
|
||||
10. runLocally() commands are executed relative to the recipe file directory. This behaviour can be overridden via an environment variable:
|
||||
```bash
|
||||
```
|
||||
DEPLOYER_ROOT=. vendor/bin/dep taskname`
|
||||
```
|
||||
11. Replace `local()` tasks with combination of `once()` and `runLocally()` func.
|
||||
|
@ -23,7 +23,7 @@ and executes the task on all specified hosts.
|
||||
The `dep` CLI looks for `deploy.php` or `deploy.yaml` file in current directory.
|
||||
|
||||
Or recipe can be specified explicitly via `-f` or `--file` option.
|
||||
```bash
|
||||
```
|
||||
$ dep --file=deploy.php deploy deployer.org
|
||||
```
|
||||
:::
|
||||
|
18
docs/cli.md
18
docs/cli.md
@ -5,7 +5,7 @@ After [installation](installation.md) of Deployer you will have the ability to r
|
||||
To get list of all available tasks run the `dep` command. You can run it from any subdirectories of you project;
|
||||
Deployer will automatically find project root dir.
|
||||
|
||||
```bash
|
||||
```
|
||||
Deployer
|
||||
|
||||
Usage:
|
||||
@ -32,7 +32,7 @@ Available commands:
|
||||
|
||||
The best way to configure your `deploy.php` is to automatically deploy to staging on this command:
|
||||
|
||||
```bash
|
||||
```
|
||||
dep deploy
|
||||
```
|
||||
|
||||
@ -40,7 +40,7 @@ This is so somebody can't accidentally deploy to production (for production depl
|
||||
|
||||
You need info about available options and usage use the `help` command:
|
||||
|
||||
```bash
|
||||
```
|
||||
$ dep help deploy
|
||||
Usage:
|
||||
deploy [options] [--] [<stage>]
|
||||
@ -82,13 +82,13 @@ set('ssh_multiplexing', false);
|
||||
|
||||
And you want to enable [ssh multiplexing](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Multiplexing) without modifying the file, you can pass the `-o` option to the `dep` command:
|
||||
|
||||
```bash
|
||||
```
|
||||
dep deploy -o ssh_multiplexing=true
|
||||
```
|
||||
|
||||
To override multiple config options, you can pass multiple `-o` args:
|
||||
|
||||
```bash
|
||||
```
|
||||
dep deploy -o ssh_multiplexing=true -o branch=master
|
||||
```
|
||||
|
||||
@ -96,7 +96,7 @@ dep deploy -o ssh_multiplexing=true -o branch=master
|
||||
|
||||
Deployer comes with a command to run any valid command on you server without modifying _deploy.php_
|
||||
|
||||
```bash
|
||||
```
|
||||
dep run 'ls -la'
|
||||
```
|
||||
|
||||
@ -112,7 +112,7 @@ To specify the hosts this command has the corresponding options:
|
||||
|
||||
You can get more info about any commands by using the help command:
|
||||
|
||||
```bash
|
||||
```
|
||||
dep help [command]
|
||||
```
|
||||
|
||||
@ -121,7 +121,7 @@ dep help [command]
|
||||
Deployer comes with an autocomplete script for bash/zsh/fish, so you don't need to remember all the tasks and options.
|
||||
To install it run following command:
|
||||
|
||||
```bash
|
||||
```
|
||||
dep autocomplete
|
||||
```
|
||||
|
||||
@ -130,7 +130,7 @@ And follow instructions.
|
||||
### Local root directory
|
||||
|
||||
By default `runLocally()` commands are executed relative to the recipe file directory. This can be overridden globally by setting an environment variable:
|
||||
```bash
|
||||
```
|
||||
DEPLOYER_ROOT=. dep taskname`
|
||||
```
|
||||
|
||||
|
@ -11,7 +11,7 @@ First, [install the Deployer](installation.md).
|
||||
|
||||
Let's `cd` into our app repo and run following command:
|
||||
|
||||
```bash
|
||||
```
|
||||
dep init
|
||||
```
|
||||
|
||||
@ -37,13 +37,13 @@ server using domain name instead of IP address.
|
||||
:::
|
||||
|
||||
After VPS created, let's try to ssh as root:
|
||||
```bash
|
||||
```
|
||||
ssh root@example.com
|
||||
```
|
||||
|
||||
Now let's provision our server.
|
||||
|
||||
```bash
|
||||
```
|
||||
dep provision -o remote_user=root
|
||||
```
|
||||
|
||||
@ -65,13 +65,13 @@ app.
|
||||
## Configure a deployment
|
||||
|
||||
Let's deploy our application:
|
||||
```bash
|
||||
```
|
||||
dep deploy
|
||||
```
|
||||
|
||||
Now we can ssh to host and edit, for example, `.env`.
|
||||
|
||||
```bash
|
||||
```
|
||||
dep ssh
|
||||
```
|
||||
|
||||
@ -87,7 +87,7 @@ after('deploy:update_code', 'build');
|
||||
```
|
||||
|
||||
Also, Deployer has a useful task for examine what is currently deployed.
|
||||
```bash
|
||||
```
|
||||
$ dep releases
|
||||
task releases
|
||||
+---------------------+--------- deployer.org -------+--------+-----------+
|
||||
|
@ -19,7 +19,7 @@ task('test', function () {
|
||||
});
|
||||
```
|
||||
|
||||
```bash
|
||||
```
|
||||
$ dep test
|
||||
[example.org] The example.org is example.org
|
||||
```
|
||||
@ -34,7 +34,7 @@ host('example.org')
|
||||
Now new hostname will be used for ssh connect, and host will be referred in
|
||||
Deployer via the alias.
|
||||
|
||||
```bash
|
||||
```
|
||||
$ dep test
|
||||
[example.org] The example.org is example.cloud.google.com
|
||||
```
|
||||
|
@ -15,7 +15,7 @@ Deployer comes with an autocomplete support for task names, options, and hosts.
|
||||
|
||||
Add next line to your `~/.bashrc` or `~/.zshrc`:
|
||||
|
||||
```bash
|
||||
```
|
||||
eval "$(dep autocomplete --shell bash)"
|
||||
```
|
||||
:::
|
||||
@ -31,7 +31,7 @@ If you call a globally installed Deployer via `/usr/local/bin/dep` in a project
|
||||
directory with a locally installed Deployer at `vendor/bin/dep`, Deployer will
|
||||
redirect call to a local Deployer.
|
||||
|
||||
```bash
|
||||
```
|
||||
~/project $ dep --version
|
||||
Using ~/project/vendor/bin/dep
|
||||
Deployer 7.0.0
|
||||
|
@ -18,7 +18,7 @@ If rollback candidate marked as **BAD_RELEASE**, it will be skipped.
|
||||
|
||||
:::tip
|
||||
You can override rollback candidate via:
|
||||
```bash
|
||||
```
|
||||
dep rollback -o rollback_candidate=123
|
||||
```
|
||||
:::
|
||||
@ -38,7 +38,7 @@ bad by creating file **BAD_RELEASE** with timestamp and [user](/docs/recipe/comm
|
||||
|
||||
:::warning
|
||||
You can always manually symlink [current_path](/docs/recipe/common.md#current_path) to proper release.
|
||||
```bash
|
||||
```
|
||||
dep run '{{bin/symlink}} releases/123 {{current_path}}'
|
||||
```
|
||||
:::
|
||||
|
@ -11,7 +11,7 @@ use Deployer\Exception\Exception;
|
||||
*
|
||||
* :::tip
|
||||
* You can override rollback candidate via:
|
||||
* ```bash
|
||||
* ```
|
||||
* dep rollback -o rollback_candidate=123
|
||||
* ```
|
||||
* :::
|
||||
@ -54,7 +54,7 @@ desc('Rollbacks to the previous release');
|
||||
*
|
||||
* :::warning
|
||||
* You can always manually symlink {{current_path}} to proper release.
|
||||
* ```bash
|
||||
* ```
|
||||
* dep run '{{bin/symlink}} releases/123 {{current_path}}'
|
||||
* ```
|
||||
* :::
|
||||
|
@ -28,7 +28,7 @@ Note: E2E tests will only run in an environment where env variable `E2E_ENV` has
|
||||
|
||||
The container can be accessed by running:
|
||||
|
||||
```bash
|
||||
```
|
||||
docker-compose run deployer sh
|
||||
```
|
||||
|
||||
@ -47,7 +47,7 @@ The `deployer` container contains:
|
||||
|
||||
It is possible to access the `server` container via ssh by running:
|
||||
|
||||
```bash
|
||||
```
|
||||
ssh deployer@server
|
||||
```
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user