Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@SamKirkland
SamKirkland committed Aug 31, 2020
1 parent a923da7 commit 81ee749
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ I strongly recommend you store your `password` as a secret.
| `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) |
| `local-dir` | No | `./myFolderToPublish/` | `./` | Path to upload to on the server, must end with trailing slash `/` |
| `server-dir` | No | `public_html/www/` | `./` | Folder to upload from, must end with trailing slash `/` |
| `state-name` | No | `folder/.sync-state.json` | `.ftp-deploy-sync-state.json` | Custom |
| `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 |
| `dry-run` | No | `true` | `false` | Prints which modifications will be made with current config options, but doesn't actually make any changes |
| `dangerous-clean-slate` | No | `true` | `false` | Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument |
| `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 |
Expand Down
33 changes: 33 additions & 0 deletions action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,39 @@ inputs:
password:
required: true
description: 'ftp password'
protocol:
required: false
description: 'protocol to deploy with - ftp, ftps, or ftps-legacy'
port:
required: false
description: 'Server port to connect to (read your web hosts docs)'
local-dir:
required: false
description: 'Folder to upload from, must end with trailing slash /'
server-dir:
required: false
description: 'Path to upload to on the server. Must end with trailing slash /'
state-name:
required: false
description: 'Path and name of the state file - this file is used to track which files have been deployed'
dry-run:
required: false
description: 'Prints which modifications will be made with current config options, but doesn't actually make any changes'
dangerous-clean-slate:
required: false
description: 'Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument'
include:
required: false
description: 'An array of glob patterns, these files will always be included in the publish/delete process - even if no change occurred'
exclude:
required: false
description: 'An array of glob patterns, these files will not be included in the publish/delete process'
log-level:
required: false
description: 'How verbose should the information be - warn, info, debug'
security:
required: false
description: 'strict or loose'
runs:
using: 'node12'
main: 'dist/index.js'
Expand Down

0 comments on commit 81ee749

Please sign in to comment.