actions
/
burnett01-rsync-deployments
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add updated readme for Yaml style actions

This commit is contained in:
Mick Ryan 2019-09-14 11:33:49 -07:00
parent c36b09ff5d
commit 8ad6165315
1 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -6,31 +6,44 @@ This action would usually follow a build/test action which leaves deployable cod
# 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. This should be set in the Github secrets section and then referenced as an `env` variable.
# Required ARGs # Required ARGs
This action requires 4 args in the `with` block.
This action can receive three `ARG`s: 1. `swtiches` - The first is for any initial/required rsync flags, eg: `-avzr --delete`
1. The first is for any initial/required rsync flags, eg: `-avzr --delete` 2. `excludes` - Any `--exclude` flags and directory pairs, eg: `--exclude .htaccess --exclude /uploads/`. Use "" if none required.
2. The second is for any `--exclude` flags and directory pairs, eg: `--exclude .htaccess --exclude /uploads/`. Use "" if none required. 3. `path` - The path to your desired directory to be deployed, if none; use `""`
3. The third is for the deployment target, and should be in the format: `[USER]@[HOST]:[PATH]` 4. `upload_path` - The deployment target, and should be in the format: `[USER]@[HOST]:[PATH]`
# Example usage # Example usage
``` ```
workflow "All pushes" { name: DEPLOY
on = "push" on:
resolves = ["Deploy to Staging"] push:
} branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: rsync deployments
uses: mickr/rsync-deployments@master
with:
switches: -avzr --delete
excludes: ""
path: src/
upload_path: user@example.com:/var/www/html/
env:
DEPLOY_KEY: ${{ secrets.private_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 ## Disclaimer