nemunaire/drone-ftps
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README to drone 1.0.0

Browse Source
This commit is contained in:
Christoph Schlosser 2019-05-17 20:15:51 +02:00 committed by GitHub
parent 13ab12a0c5
commit f99d405a71
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 51 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
README.md
View File

@ -9,53 +9,64 @@
You have to set the username and password for your FTP server in the `FTP_USERNAME` and `FTP_PASSWORD` secret. You have to set the username and password for your FTP server in the `FTP_USERNAME` and `FTP_PASSWORD` secret.
### Basic
## Optional settings
```yaml ```yaml
pipeline: environment:
deploy: 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 image: cschlosser/drone-ftps
hostname: example.com:21 environment:
secrets: [ ftp_username, ftp_password ] 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 - name: develop_build
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:
image: cschlosser/drone-ftps image: cschlosser/drone-ftps
hostname: example.com:21 environment:
secrets: [ ftp_username, ftp_password ] FTP_USERNAME:
secure: true (default) | false # true = use FTP(S), false = FTP without SSL from_secret: username
verify: true (default) | false # true = strong SSL verification, false = supress SSL verification error FTP_PASSWORD:
chmod: true (default) | false # true = chmod after file transferred, false = no chmod after file transferred from_secret: password
clean_dir: true | false (default) # true = clean destination directory before transferring files, false = don't clean PLUGIN_HOSTNAME: example.com:21
dest_dir: /var/www/mysite PLUGIN_DEST_DIR: /develop
src_dir: /mysite/static PLUGIN_SECURE: false
exclude: PLUGIN_VERIFY: false
- ^\.git/$ PLUGIN_EXCLUDE: ^\.git/$
- ^\.gitignore$ when:
- ^\.drone.yml$ branch:
include: - develop
- ^*.css$ event:
- ^*.js$ - push
- ^*.html$
``` ```