Version 4.0.0

[SamKirkland]

Version 4.0.0 🚀

Migration Guide

Over the past few months I've been rewriting this action with a brand new architecture that resolves some long standing issues. The new version of this library is heavily inspired by rsync. rsync is a popular application that must be run over a ssh connection, it requires the rsync binary be install on both the client and the sever. rsync provides dozens of advanced arguments that can't be supported due to protocol limitations with ftp. Version 4 attempts to emulate at a high level how rsync syncs multiple folders, however operates over the constrained ftp protocol.

Less overhead

Version 4 no longer uses docker and has faster startup times!

Improved Defaults

.git and node_modules are now ignored by default, allowing users to opt-in to their deployment instead.

Improved Error Handling

Errors are now less cryptic.

Local Testing

Testing actions in version 3 was difficult, often requiring devs to change a value and commit it without testing the change locally. You can now run test configurations using node, see readme for more info.

Minimize downtime

The deployment is now setup in a way that minimizes downtime. For example, new files can be uploaded, then existing files updated, and finally old files deleted.

Removed features 🗑️

sftp support has been removed. In hindsight this never should have been added. Users with sftp access should be using rsync over ssh. I will create a separate github action for rsync deployments (coming soon)

---

Open Issues Resolved in Version 4 ✅

• Beta version - Version 4 - Error: Using Local-Dir Causing No Such File or Directory #108, Version 4 - Looking for Testers #102
• Removing git-based file tracking React deployment doesn't work unless I commit build folder #101, Issue with WordPress  #99, fatal: Not a Git project? Exiting... on self-hosted runner #88, Unknown SHA1 object, could not determine changed files, taking all files. #82, FTP-Deploy-Action keeps running forever #78, ##[error]The process '/usr/bin/git' failed with exit code 5 #76, fatal: Dirty repository: Having uncommitted changes. Exiting... #68, Make auto-init optional #56, Clear the folder before/after upload #52, Dirty repository when uploading build product #49, Local dir set, but parent folders are still being uploaded #46, Syncronization of subdir "lib" fails #40
• Local testing - The Docker build does not run #71
• Better defaults - Default exclusion of the .github-folder #66, local-dir default is not the same as specifying ./ explicitly #57
• Better error handling - Translate error code #48, Connection closed without reason #19
• Detect when hosts require ftp/ftps/ftpes and output helper text - related issues curl: (67) Access denied: 530 - The process '/usr/bin/git' failed with exit code 5 #87
• Other issues - --insecure flag stops the execution #83
• SFTP - Unexpected input(s) 'known-hosts' #98, KEY and PUBKEY not getting passed properly. #79, [FEATURE REQUEST]: Add an option to set private key from Secrets #63
• better documentation/warning on escaping spaces/quotes - ##[error]The process '/usr/bin/git' failed with exit code 3 #80