Skip to content

Commit 55531c3

Browse files
committed
feat(setBranch/getBranch): add documentation
1 parent 4227dad commit 55531c3

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/hosts.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ The typed setter methods give better IDE autocompletion:
7171
```php
7272
host('example.org')
7373
->setHostname('example.cloud.google.com')
74-
->setRemoteUser('deployer');
74+
->setRemoteUser('deployer')
75+
->setBranch('production');
7576
```
7677

7778
---
@@ -130,6 +131,7 @@ set('default_selector', "stage=prod&role=web,role=special");
130131
| **`ssh_multiplexing`** | Enable SSH multiplexing for performance. Default is `true`. |
131132
| **`shell`** | Shell to use. Default is `bash -ls`. |
132133
| **`deploy_path`** | Directory for deployments. E.g., `~/myapp`. |
134+
| **`branch`** | Git branch to deploy for this host. Overrides the global `branch` config when set. Use `setBranch()` for a typed setter. |
133135
| **`labels`** | Key-value pairs for host selection. |
134136
| **`ssh_arguments`** | Additional SSH options. E.g., `['-o UserKnownHostsFile=/dev/null']`. |
135137
| **`ssh_control_path`** | Control path for SSH multiplexing. Default is `~/.ssh/%C` or `/dev/shm/%C` in CI environments. |

0 commit comments

Comments
 (0)