Skip to content
GitHub Action for deploying code via rsync over ssh
Dockerfile Shell
Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
Branch: master
Clone or download

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Dockerfile Updated refs in Dockerfile to current url. May 13, 2019
LICENSE Initial commit Feb 9, 2019
README.md Minor changes to readme Feb 9, 2019
entrypoint.sh Initial code commit Feb 9, 2019

README.md

rsync deployments

This GitHub Action deploys everything in GITHUB_WORKSPACE to a folder on a server via rsync over ssh.

This action would usually follow a build/test action which leaves deployable code in GITHUB_WORKSPACE.

Required SECRETs

This action needs a DEPLOY_KEY secret variable. This should be the private key part of an ssh key pair. The public key part should be added to the authorized_keys file on the server that receives the deployment.

Required ARGs

This action can receive three ARGs:

  1. The first is for any initial/required rsync flags, eg: -avzr --delete

  2. The second is for any --exclude flags and directory pairs, eg: --exclude .htaccess --exclude /uploads/. Use "" if none required.

  3. The third is for the deployment target, and should be in the format: [USER]@[HOST]:[PATH]

Example usage

workflow "All pushes" {
  on = "push"
  resolves = ["Deploy to Staging"]
}

action "Deploy to Staging" {
  uses = "contention/action-rsync-deploy@master"
  secrets = ["DEPLOY_KEY"]
  args = ["-avzr --delete", "--exclude .htaccess --exclude /uploads/", "user@server.com:/srv/myapp/public/htdocs/"]
} 

Disclaimer

If you're using GitHub Actions, you'll probably already know that it's still in limited public beta, and GitHub advise against using Actions in production.

So, check your keys. Check your deployment paths. And use at your own risk.

You can’t perform that action at this time.