github
/
drone-s3-sync
mirror of https://github.com/thegeeklab/drone-s3-sync.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity

Unified README and updated badges

This commit is contained in:
Thomas Boerger 2016-07-31 19:35:39 +02:00
parent afad33ff8a
commit cca1f8f702
No known key found for this signature in database
GPG Key ID: 5A388F55283960B6
1 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,21 +1,21 @@
# drone-s3-sync
[![Build Status](http://beta.drone.io/api/badges/drone-plugins/drone-s3-sync/status.svg)](http://beta.drone.io/drone-plugins/drone-s3-sync)
[![](https://badge.imagelayers.io/plugins/drone-s3-sync:latest.svg)](https://imagelayers.io/?images=plugins/drone-s3-sync:latest 'Get your own badge on imagelayers.io')
[![Go Doc](https://godoc.org/github.com/drone-plugins/drone-s3-sync?status.svg)](http://godoc.org/github.com/drone-plugins/drone-s3-sync)
[![Go Report](https://goreportcard.com/badge/github.com/drone-plugins/drone-s3-sync)](https://goreportcard.com/report/github.com/drone-plugins/drone-s3-sync)
[![Join the chat at https://gitter.im/drone/drone](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/drone/drone)
Drone plugin to synchronize a directory with an Amazon S3 Bucket. For the usage information and a listing of the available options please take a look at [the docs](DOCS.md).
Drone plugin to synchronize a directory with an Amazon S3 Bucket. For the
usage information and a listing of the available options please take a look at
[the docs](DOCS.md).
## Build
Build the binary with the following commands:
```
export GO15VENDOREXPERIMENT=1
export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
go build -a -tags netgo
go build
go test
```
## Docker
@ -23,10 +23,12 @@ go build -a -tags netgo
Build the docker image with the following commands:
```
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -tags netgo
docker build --rm=true -t plugins/s3-sync .
```
Please note incorrectly building the image, with the wrong OS, architecture, or with CGO enabled will result in an error when running the Docker image:
Please note incorrectly building the image for the correct x64 linux and with
GCO disabled will result in an error when running the Docker image:
```
docker: Error response from daemon: Container command
@ -35,16 +37,16 @@ docker: Error response from daemon: Container command
## Usage
Build and publish from your current working directory:
Execute from the working directory:
```
```sh
docker run --rm \
-e PLUGIN_SOURCE=<source> \
-e PLUGIN_TARGET=<target> \
-e PLUGIN_BUCKET=<bucket> \
-e AWS_ACCESS_KEY_ID=<access_key> \
-e PLUGIN_SOURCE=<source> \
-e PLUGIN_TARGET=<target> \
-e PLUGIN_BUCKET=<bucket> \
-e AWS_ACCESS_KEY_ID=<access_key> \
-e AWS_SECRET_ACCESS_KEY=<secret_key> \
-v $(pwd):$(pwd) \
-w $(pwd) \
-v $(pwd):$(pwd) \
-w $(pwd) \
plugins/s3-sync
```