Skip to content

Commit

Permalink
Merge pull request #11 from contention/v2-dev
Browse files Browse the repository at this point in the history
V2 dev
  • Loading branch information
contention authored Apr 9, 2023
2 parents 65ac047 + ac11b74 commit 10f98a8
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 33 deletions.
12 changes: 2 additions & 10 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
FROM debian:9.5-slim


# Update
RUN apt-get update


# Install packages
RUN apt-get -yq install rsync openssh-client
FROM drinternet/rsync:v1.4.3


# Label
LABEL "com.github.actions.name"="rsync deployments"
LABEL "com.github.actions.description"="For deploying code to a webserver via rsync over ssh"
LABEL "com.github.actions.description"="Quick and simple method of deploying code to a webserver via rsync over ssh"
LABEL "com.github.actions.icon"="truck"
LABEL "com.github.actions.color"="yellow"

Expand Down
58 changes: 37 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,56 @@
# rsync deployments

This GitHub Action deploys *everything* in `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh.
This GitHub Action deploys files 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
# 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
# Required inputs

This action can receive three `ARG`s:
This action requires six inputs:

1. The first is for any initial/required rsync flags, eg: `-avzr --delete`
1. `FLAGS` 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.
2. `EXCLUDES` 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]`
3. `USER` for the server user, eg: `deploybot`

4. `HOST` for the deployment target, eg: `myserver.com`

5. `LOCALPATH` for the local path to sync, eg: `/dist/`

5. `REMOTEPATH` for the remote path to sync, eg: `/srv/myapp/public/htdocs/`

# 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/", "[email protected]:/srv/myapp/public/htdocs/"]
}
```
name: Deploy to production
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: contention/[email protected]
with:
FLAGS: -avzr --delete
EXCLUDES: --exclude .htaccess --exclude /uploads/
USER deploybot
HOST: myserver.com
LOCALPATH: /dist/
REMOTEPATH: /srv/myapp/public/htdocs/
DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
## 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.
## REMINDER!

So, check your keys. Check your deployment paths. And use at your own risk.
Check your keys. Check your deployment paths. Check your flags. And use at your own risk.
31 changes: 31 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: 'rsync deployments'
description: 'Quick and simple method of deploying code to a webserver via rsync over ssh'
author: 'Contention'
inputs:
flags:
description: 'Initial/required rsync flags'
required: true
excludes:
description: 'Exclude flags and directory pairs'
required: true
user:
description: 'The server user'
required: true
host:
description: 'The deployment target'
required: true
localpath:
description: 'The local path to sync'
required: true
remotepath:
description: 'The remote path to sync'
required: true
deploy_key:
description: 'The private key'
required: true
runs:
using: 'docker'
image: 'Dockerfile'
branding:
icon: 'truck'
color: 'yellow'
4 changes: 2 additions & 2 deletions entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ set -eu
# Set deploy key
SSH_PATH="$HOME/.ssh"
mkdir "$SSH_PATH"
echo "$DEPLOY_KEY" > "$SSH_PATH/deploy_key"
echo "$INPUT_DEPLOY_KEY" > "$SSH_PATH/deploy_key"
chmod 600 "$SSH_PATH/deploy_key"


# Do deployment
sh -c "rsync $1 -e 'ssh -i $SSH_PATH/deploy_key -o StrictHostKeyChecking=no' $2 $GITHUB_WORKSPACE/ $3"
sh -c "rsync $INPUT_FLAGS -e 'ssh -i $SSH_PATH/deploy_key -o StrictHostKeyChecking=no' $INPUT_EXCLUDES $GITHUB_WORKSPACE/$INPUT_LOCALPATH $INPUT_USER@$INPUT_HOST:$INPUT_REMOTEPATH"

0 comments on commit 10f98a8

Please sign in to comment.