README.md
# node-deploy-server-php-pusher
[![Build Status](https://travis-ci.org/CapsLock-Studio/node-deploy-server-php-pusher.svg)](https://travis-ci.org/CapsLock-Studio/node-deploy-server-php-pusher)
[![Coverage Status](https://coveralls.io/repos/github/CapsLock-Studio/node-deploy-server-php-pusher/badge.svg)](https://coveralls.io/github/CapsLock-Studio/node-deploy-server-php-pusher)
[![Code Climate](https://codeclimate.com/github/CapsLock-Studio/node-deploy-server-php-pusher/badges/gpa.svg)](https://codeclimate.com/github/CapsLock-Studio/node-deploy-server-php-pusher)
[![Issue Count](https://codeclimate.com/github/CapsLock-Studio/node-deploy-server-php-pusher/badges/issue_count.svg)](https://codeclimate.com/github/CapsLock-Studio/node-deploy-server-php-pusher)
### Installation
```sh
composer global require capslock-studio/node-deploy-server-php-pusher dev-master
ln -s $HOME/.composer/vendor/bin/deploy-pusher /usr/local/bin/deploy-pusher
```
### How to use
```sh
DEPLOY_HOST={DEFINE_YOUR_NODE_DEPLOY_SERVER} SECRET={DEFINE_YOUR_SECRET} DIST={REMOTE_SERVER_DEPLOY_PATH} deploy-pusher [PARAMETER_WITH_DOUBLE_DASH]
```
### Windows user
```sh
set DEPLOY_HOST={DEFINE_YOUR_NODE_DEPLOY_SERVER}
set SECRET={DEFINE_YOUR_SECRET}
set DIST={REMOTE_SERVER_DEPLOY_PATH}
php .\deploy-pusher [PARAMETER_WITH_DOUBLE_DASH]
```
### Shell Parameters
* `--tag` - Specify the tag you want to deploy
* `--rollback` - Rollback to the previous version
* `--config` - Load parameter from JSON file
* `--command` - Commands you will execute after deploy successfully.(multiple)
* `--ignore` - Folders you want to keep.(multiple)
### ENV
* `SECRET` - Secret key to encrypt json payload.
* `DEPLOY_HOST` - Server you want to deploy!
### Supported CI platform
* TravisCI
* Jenkins
* CircleCI
### Other CI platform
You have to assign `REPO` and `OWNER` to your environment variable in other CI tool.