README.md

ssh-scp-deploy

❔ Why should I use this action?

Because this action provide an easy and highly customizable way to upload files via scp and execute a set of command via ssh before or/and after.
I use this action to deploy my personal projects to remote server, restarting the needed services or to do a simple upload via scp.

🏃 Supported runners

👤 Author

Marco Dalla Santa

• Twitter: @marcodallasanta
• Github: @marcodallasanta
• LinkedIn: @marcodallasanta

⚙️ Usage

    - uses: mdallasanta/ssh-scp-deploy@{version}
      with:
        local: './'                                                  # Local file path - REQUIRED false - DEFAULT ./
        remote: '~/'                                                 # Remote file path - REQUIRED false - DEFAULT ~/
        host: ${{secrets.HOST}}                                      # Remote server address - REQUIRED true
        port: ${{secrets.PORT}}                                      # Remote server port - REQUIRED false - DEFAULT 22
        user: ${{secrets.USER}}                                      # Remote server user - REQUIRED true
        password: ${{secrets.PASSWORD}}                              # User password - REQUIRED at least one of "password" or "key" 
        key: ${{secrets.KEY}}                                        # Remote server private key - REQUIRED at least one of "password" or "key" 
        pre_upload: echo "This will be executed before the upload!"  # Command to run via ssh before scp upload - REQUIRED false
        post_upload: echo "This will be executed after the upload!"  # Command to run via ssh after scp upload - REQUIRED false
        ssh_options: -o StrictHostKeyChecking=no                     # A set of ssh_option separated by -o - REQUIRED false - DEFAULT -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null
        scp_options: -v                                              # Flags to use during scp - REQUIRED false - DEFAULT ''

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

🙏 Thanks

Thanks to:

• Raphaël Bussa for help in testing.
• jamesremuscat for resolving issue#15
• Blake Drumm for resolving issue#19

📝 License

Copyright © 2020-2022 Marco Dalla Santa

The source code, scripts and documentation in this project are released under the MIT License