Skip to content

Commit 57afa04

Browse files
committed
Updated readme according to recent changes
1 parent d7b6e40 commit 57afa04

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Attributes are used to set default values only.
3939

4040
| Key | Default |
4141
|:------------------------------------|:---------|
42-
| `['ama-docker-compose']['version']` | `1.12.0` |
42+
| `['ama-docker-compose']['version']` | `1.16.1` |
4343

4444
## Recipes
4545

@@ -84,6 +84,12 @@ Examples:
8484
docker_compose_deployment '/srv/router/docker-compose.yml'
8585
```
8686

87+
```ruby
88+
docker_compose_deployment '/srv/router/docker-compose.yml' do
89+
environment({COMPOSE_PROJECT_NAME: 'my_custom_name'})
90+
end
91+
```
92+
8793
```ruby
8894
docker_compose_deployment 'router' do
8995
executable '/usr/local/bin/docker-compose'
@@ -111,6 +117,7 @@ Attributes:
111117
| `shell_timeout` | Integer / Nil | `300` | Timeout for any underlying command to prevent infinite stalling |
112118
| `signal` | String | `SIGKILL` | Signal for kill command |
113119
| `scale` | String | | Arguments for docker-compose scale command e.g. `nginx=2`|
120+
| `environment` | Hash / Nil | `{}` | Arbitrary environment variables to be passed to docker-compose call
114121

115122
Available actions are:
116123

0 commit comments

Comments
 (0)