edwrodrig / deployer
Library to deploy folders to github or remotes using rsync
Requires
- php: ^7.2
Requires (Dev)
- phpunit/phpunit: ^7.0
README
Library to deploy folders to github or remotes using rsync
My use cases
Deploy static generated pages to:
- a github repository used as a github pages host.
- a remote folder using rsync through ssh.
My infrastructure is targeted to Ubuntu 16.04 machines with last php7.2 installed from ppa:ondrej/php
All transfer are secured by ssh with proper host key fingerprints and private keys. If you don't know what are these or why are important go to read about it now.
Documentation
The source code is documented using phpDocumentor style, so it should pop up nicely if you're using IDEs like PhpStorm or similar.
Examples
Composer
composer require edwrodrig/deployer
Testing
This library uses phpunit, but you need to run a virtual machine with a dummy host. The dummy host is a TinyCoreLinux with ssh, rsync and git.
The virtual machine is provided as a VirtualBox appliance in files/DeployerTextTarget.ova. The virtual machine must be running while the test are running.
License
MIT license. Use it as you want at your own risk.
About language
I'm not a native english writer, so there may be a lot of grammar and orthographical errors on text, I'm just trying my best. But feel free to correct my language, any contribution is welcome and for me they are a learning instance.