docs: add example

This commit is contained in:
Bo-Yi Wu
2019-09-28 12:26:40 +08:00
parent 5138976c70
commit 6fd371aeaf
3 changed files with 46 additions and 0 deletions

View File

@@ -37,6 +37,7 @@ see the [action.yml](./action.yml) file for more detail imformation.
* target - target path on the server
* source - scp file list
* rm - remove target folder before upload data
* strip_components - remove the specified number of leading path elements.
### Example
@@ -98,3 +99,35 @@ Example configuration for multiple server
source: "tests/a.txt,tests/b.txt"
target: "test"
```
remove the specified number of leading path elements
```yaml
- name: remove the specified number of leading path elements
uses: appleboy/scp-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt"
target: "foobar"
strip_components: 1
```
old target structure:
```sh
foobar
└── tests
├── a.txt
└── b.txt
```
new target structure:
```sh
foobar
├── a.txt
└── b.txt
```