From 81ee749b949b270aa09b1a7732bcf49f3aa42f73 Mon Sep 17 00:00:00 2001 From: SamKirkland Date: Sun, 30 Aug 2020 23:25:49 -0500 Subject: [PATCH] updating readme --- README.md | 2 +- action.yml | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d9c36b..4b9fbd1 100644 --- a/README.md +++ b/README.md @@ -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 | diff --git a/action.yml b/action.yml index 019cca6..10f9262 100644 --- a/action.yml +++ b/action.yml @@ -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'