Skip to content

Commit 51c995c

Browse files
committed
update docs to include region
1 parent ed70804 commit 51c995c

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ steps:
280280

281281
### Changing the name of exported variable
282282

283-
By default image name and computed tag are exported to the Docker buildkite plugin env variable `BUILDKITE_PLUGIN_DOCKER_IMAGE`. In order to chain the plugin with a different plugin, this can be changed by specifying a `export-env-variable` parameter:
283+
By default, image name and computed tag are exported to the Docker buildkite plugin env variable `BUILDKITE_PLUGIN_DOCKER_IMAGE`. In order to chain the plugin with a different plugin, this can be changed by specifying a `export-env-variable` parameter:
284284

285285
```yaml
286286
steps:
@@ -311,6 +311,19 @@ steps:
311311
- docker#v3.8.0
312312
```
313313

314+
#### Specifying a region
315+
316+
By default, the plugin uses the region specified in the `AWS_DEFAULT_REGION` environment variable. If this environment variable is not present, it defaults to the `eu-west-1` region. You can optionally specify the region in which you would like your cache to reside in:
317+
318+
```yaml
319+
steps:
320+
- command: echo wow
321+
plugins:
322+
- seek-oss/docker-ecr-cache#v1.11.0:
323+
region: ap-southeast-2
324+
- docker#v3.8.0
325+
```
326+
314327
#### Required permissions
315328

316329
Below is a sample set of IAM policy statements that will allow this plugin to work:

0 commit comments

Comments
 (0)