actions/rsync-deployments
1
0
Fork 0
mirror of https://gitee.com/jiulinxiri/rsync-deployments.git synced 2025-09-10 18:05:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated to reflect v2

Browse Source
This commit is contained in:
Contention
2023-03-24 16:22:22 +00:00
committed by GitHub
parent b111bee195
commit 862fef3e69
1 changed files with 36 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@@ -4,37 +4,54 @@ This GitHub Action deploys *everything* in `GITHUB_WORKSPACE` to a folder on a s
This action would usually follow a build/test action which leaves deployable code in `GITHUB_WORKSPACE`. 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. 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 deployment target, and should be in the format: `deploybot`
4. `HOST` for the server user, eg: `myserver.com`
5. `LOCALPATH` for the local path to sync, eg: `/src`
5. `REMOTEPATH` for the remote path to sync, eg: `/srv/myapp/public/htdocs/`
# Example usage # Example usage
``` ```
workflow "All pushes" { name: Deploy to production
on = "push"
resolves = ["Deploy to Staging"] on:
} push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: contention/rsync-deployments@v2.0.0
with:
FLAGS: -avzr --delete
EXCLUDES: --exclude .htaccess
USER deploybot
HOST: myserver.com
LOCALPATH: /dist
DEST: /srv/myapp/public/htdocs/
env:
DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
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 ## REMINDER!
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. Check your keys. Check your deployment paths. Check your flags. And use at your own risk.
So, check your keys. Check your deployment paths. And use at your own risk.