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

Update README.md

This commit is contained in:
Steven Agyekum 2019-12-04 19:09:24 +01:00 committed by GitHub
parent 050c29bcea
commit 682623851b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -7,7 +7,9 @@ This GitHub Action deploys files in `GITHUB_WORKSPACE` to a folder on a server v
Use this action in a build/test workflow which leaves deployable code in `GITHUB_WORKSPACE`. Use this action in a build/test workflow which leaves deployable code in `GITHUB_WORKSPACE`.
# Inputs ---
##Inputs
- `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete` - `switches`* - The first is for any initial/required rsync flags, eg: `-avzr --delete`
@ -27,11 +29,11 @@ Use this action in a build/test workflow which leaves deployable code in `GITHUB
``* = Required`` ``* = Required``
# Required secret ## Required secret
This action needs a `DEPLOY_KEY` secret variable. This should be the private key part of a 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 the `remote_key` input. This action needs a `DEPLOY_KEY` secret variable. This should be the private key part of a 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 the `remote_key` input.
# Example usage ## Example usage
Simple: Simple:
@ -109,3 +111,13 @@ jobs:
remote_user: ${{ secrets.DEPLOY_USER }} remote_user: ${{ secrets.DEPLOY_USER }}
remote_key: ${{ secrets.DEPLOY_KEY }} remote_key: ${{ secrets.DEPLOY_KEY }}
``` ```
---
## Version 1.0 (EOL)
Looking for version 1.0?
Check here: https://github.com/Burnett01/rsync-deployments/tree/1.0
Please note that version 1.0 has reached end of life state.