actions/ssh-deploy
1
0
Fork 0
mirror of https://github.com/easingthemes/ssh-deploy.git synced 2025-06-21 03:52:11 +10:00
Code Issues Projects Releases Packages Wiki Activity Actions

add optional REMOTE_PORT env to configuration

Browse source
This commit is contained in:
Filip Malinowski 2019-12-29 15:36:34 +01:00
parent a3d2df0501
commit 0d77a6681b
6 changed files with 44 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -4,7 +4,7 @@ Deploy code with rsync over ssh, using NodeJS.
NodeJS version is more than a minute `faster` than simple Docker version.
This GitHub Action deploys specific directory from `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh, using NodeJS.
This GitHub Action deploys specific directory from `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh, using NodeJS.
This action would usually follow a build/test action which leaves deployable code in `GITHUB_WORKSPACE`, eg `dist`;
@ -16,14 +16,18 @@ Pass configuration with `env` vars
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.
2. `REMOTE_HOST` [required]
2. `REMOTE_HOST` [required]
eg: mydomain.com
3. `REMOTE_USER` [required]
3. `REMOTE_USER` [required]
eg: myusername
3. `REMOTE_PORT` (optional, default '22')
eg: '59184'
2. `ARGS` (optional, default '-rltgoDzvO')
For any initial/required rsync flags, eg: `-avzr --delete`
@ -85,6 +89,6 @@ jobs:
## 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.
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.
So, check your keys. Check your deployment paths. And use at your own risk.