Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lox committed May 2, 2017
1 parent 2805b52 commit 3a8add0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2015 Buildkite
Copyright (c) 2017 Buildkite

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
8 changes: 5 additions & 3 deletions README.md
Expand Up @@ -7,7 +7,7 @@ A [Buildkite](https://buildkite.com/) plugin allowing you to create a build syst
* Containers are built, run and linked on demand using Docker Compose
* Containers are namespaced to each build job, and cleaned up after use
* Supports pre-building of images, allowing for fast parallel builds across distributed agents
* Supports pushing images to a repository
* Supports pushing tagged images to a repository

## Example

Expand Down Expand Up @@ -138,7 +138,7 @@ steps:
run: tests
```

## Pushing Images
## Pushing Tagged Images

Prebuilt images are automatically pushed with a `build` step, but often you want to finally push your images, perhaps ready for deployment.

Expand All @@ -148,7 +148,7 @@ steps:
plugins:
docker-compose#v1.2.1:
push:
- app:index.docker.io/org/repo/myapp:
- app:index.docker.io/org/repo/myapp
- app:index.docker.io/org/repo/myapp:latest
```

Expand All @@ -169,6 +169,8 @@ The name of the service the command should be run within. If the docker-compose

A list of services to push in the format `service:image:tag`. If an image has been pre-built with the build step, that image will be re-tagged, otherwise docker-compose's built in push operation will be used.

Be aware that there is a race condition on tagging prebuilt images and pushing them if multiple push steps run in parallel. It's advisable to use a concurrency group in this situation.

### `config` (optional)

The file name of the Docker Compose configuration file to use. Can also be a list of filenames.
Expand Down

0 comments on commit 3a8add0

Please sign in to comment.