Update README to drone 1.0.0
This commit is contained in:
parent
13ab12a0c5
commit
f99d405a71
97
README.md
97
README.md
@ -9,53 +9,64 @@
|
||||
|
||||
You have to set the username and password for your FTP server in the `FTP_USERNAME` and `FTP_PASSWORD` secret.
|
||||
|
||||
### Basic
|
||||
|
||||
## Optional settings
|
||||
|
||||
```yaml
|
||||
pipeline:
|
||||
deploy:
|
||||
environment:
|
||||
FTP_USERNAME:
|
||||
from_secret: username
|
||||
FTP_PASSWORD:
|
||||
from_secret: password
|
||||
PLUGIN_HOSTNAME: example.com:21
|
||||
PLUGIN_DEST_DIR: /path/to/dest (default /)
|
||||
PLUGIN_SRC_DIR: /path/to/dest (default ./)
|
||||
PLUGIN_SECURE: true | false (default true)
|
||||
PLUGIN_VERIFY: false
|
||||
PLUGIN_EXCLUDE: (egrep like pattern matching)
|
||||
PLUGIN_INCLUDE: (egrep like pattern matching)
|
||||
```
|
||||
|
||||
## Full file example
|
||||
|
||||
```yaml
|
||||
kind: pipeline
|
||||
name: default
|
||||
|
||||
steps:
|
||||
- name: master_build
|
||||
image: cschlosser/drone-ftps
|
||||
hostname: example.com:21
|
||||
secrets: [ ftp_username, ftp_password ]
|
||||
```
|
||||
environment:
|
||||
FTP_USERNAME:
|
||||
from_secret: username
|
||||
FTP_PASSWORD:
|
||||
from_secret: password
|
||||
PLUGIN_HOSTNAME: example.com:21
|
||||
|
||||
### Optional settings
|
||||
PLUGIN_SECURE: false
|
||||
PLUGIN_VERIFY: false
|
||||
PLUGIN_EXCLUDE: ^\.git/$
|
||||
when:
|
||||
branch:
|
||||
- master
|
||||
event:
|
||||
- push
|
||||
|
||||
```yaml
|
||||
secure: true | false (default true)
|
||||
|
||||
dest_dir: /path/to/dest (default /)
|
||||
|
||||
src_dir: /path/to/src (default ./)
|
||||
|
||||
exclude: (egrep like pattern matching)
|
||||
- ^\.git/$
|
||||
- ^\.gitignore$
|
||||
- ^\.drone.yml$
|
||||
|
||||
include: like exclude
|
||||
```
|
||||
|
||||
Full file:
|
||||
|
||||
```yaml
|
||||
pipeline:
|
||||
deploy:
|
||||
- name: develop_build
|
||||
image: cschlosser/drone-ftps
|
||||
hostname: example.com:21
|
||||
secrets: [ ftp_username, ftp_password ]
|
||||
secure: true (default) | false # true = use FTP(S), false = FTP without SSL
|
||||
verify: true (default) | false # true = strong SSL verification, false = supress SSL verification error
|
||||
chmod: true (default) | false # true = chmod after file transferred, false = no chmod after file transferred
|
||||
clean_dir: true | false (default) # true = clean destination directory before transferring files, false = don't clean
|
||||
dest_dir: /var/www/mysite
|
||||
src_dir: /mysite/static
|
||||
exclude:
|
||||
- ^\.git/$
|
||||
- ^\.gitignore$
|
||||
- ^\.drone.yml$
|
||||
include:
|
||||
- ^*.css$
|
||||
- ^*.js$
|
||||
- ^*.html$
|
||||
environment:
|
||||
FTP_USERNAME:
|
||||
from_secret: username
|
||||
FTP_PASSWORD:
|
||||
from_secret: password
|
||||
PLUGIN_HOSTNAME: example.com:21
|
||||
PLUGIN_DEST_DIR: /develop
|
||||
PLUGIN_SECURE: false
|
||||
PLUGIN_VERIFY: false
|
||||
PLUGIN_EXCLUDE: ^\.git/$
|
||||
when:
|
||||
branch:
|
||||
- develop
|
||||
event:
|
||||
- push
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user