Skip to content

Commit 81ee749

Browse files
committed
updating readme
1 parent a923da7 commit 81ee749

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ I strongly recommend you store your `password` as a secret.
6868
| `protocol` | No | `ftps` | `ftp` | ftp: provides no encryption, ftps: full encryption newest standard (aka "explicit" ftps), ftps-legacy: full encryption legacy standard (aka "implicit" ftps) |
6969
| `local-dir` | No | `./myFolderToPublish/` | `./` | Path to upload to on the server, must end with trailing slash `/` |
7070
| `server-dir` | No | `public_html/www/` | `./` | Folder to upload from, must end with trailing slash `/` |
71-
| `state-name` | No | `folder/.sync-state.json` | `.ftp-deploy-sync-state.json` | Custom |
71+
| `state-name` | No | `folder/.sync-state.json` | `.ftp-deploy-sync-state.json` | Path and name of the state file - this file is used to track which files have been deployed |
7272
| `dry-run` | No | `true` | `false` | Prints which modifications will be made with current config options, but doesn't actually make any changes |
7373
| `dangerous-clean-slate` | No | `true` | `false` | Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument |
7474
| `include` | No | | `` | :warning: not implemented yet - An array of glob patterns, these files will always be included in the publish/delete process - even if no change occurred |

action.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,39 @@ inputs:
1111
password:
1212
required: true
1313
description: 'ftp password'
14+
protocol:
15+
required: false
16+
description: 'protocol to deploy with - ftp, ftps, or ftps-legacy'
17+
port:
18+
required: false
19+
description: 'Server port to connect to (read your web hosts docs)'
20+
local-dir:
21+
required: false
22+
description: 'Folder to upload from, must end with trailing slash /'
23+
server-dir:
24+
required: false
25+
description: 'Path to upload to on the server. Must end with trailing slash /'
26+
state-name:
27+
required: false
28+
description: 'Path and name of the state file - this file is used to track which files have been deployed'
29+
dry-run:
30+
required: false
31+
description: 'Prints which modifications will be made with current config options, but doesn't actually make any changes'
32+
dangerous-clean-slate:
33+
required: false
34+
description: 'Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument'
35+
include:
36+
required: false
37+
description: 'An array of glob patterns, these files will always be included in the publish/delete process - even if no change occurred'
38+
exclude:
39+
required: false
40+
description: 'An array of glob patterns, these files will not be included in the publish/delete process'
41+
log-level:
42+
required: false
43+
description: 'How verbose should the information be - warn, info, debug'
44+
security:
45+
required: false
46+
description: 'strict or loose'
1447
runs:
1548
using: 'node12'
1649
main: 'dist/index.js'

0 commit comments

Comments
 (0)