Add example

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
这个提交包含在:
Bo-Yi Wu
2019-05-15 06:32:43 +08:00
父节点 5e4c286287
当前提交 a79592f0da
共有 2 个文件被更改,包括 50 次插入 和 2 次删除

查看文件

@ -1,3 +1,33 @@
# ssh-action
# 🚀 SSH for GitHub Actions
GitHub Action for executing remote ssh commands.
[GitHub Action](https://developer.github.com/actions/) for executing remote ssh commands.
## Usage
copy files and artifacts via SSH as blow.
```
action "Copy multiple file" {
uses = "appleboy/scp-action@master"
env = {
HOST = "example.com"
USERNAME = "foo"
PASSWORD = "bar"
PORT = "22"
SOURCE = "tests/a.txt,tests/b.txt"
TARGET = "/home/foo/test"
}
secrets = [
"PASSWORD",
]
}
```
## Environment variables
* HOST - ssh server host
* PORT - ssh server port
* USERNAME - ssh server username
* PASSWORD - ssh server password
* KEY - ssh server private key
* SCRIPT - execute the scripts