actions
/
ftp-action
mirror of https://github.com/GenieTim/ftp-action.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Tim Bernhard 2020-08-24 17:44:05 +02:00 committed by GitHub
parent 13473ec234
commit 06413c723e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -2,6 +2,13 @@
Automate copying your files via ftp using this GitHub action.
View in [GitHub Marketplace](https://github.com/marketplace/actions/ftp-upload-action).
For details on how it works (and the options it sets, such as timeouts), read [`entrypoint.sh`](./entrypoint.sh).
You may be especially interested to note that:
- the `.git` folder is not (up/down)loaded
- only newer files are (up/down)loaded
## Example usage
```
@ -14,7 +21,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Upload ftp
uses: genietim/ftp-action@releases/v4
uses: ftp-upload-action@v4
with:
host: ${{ secrets.FTP_SERVER }}
user: ${{ secrets.FTP_USERNAME }}
@ -23,6 +30,8 @@ jobs:
remoteDir: "www"
```
Note that the `secrets.FTP_{SERVER,USERNAME,PASSWORD}` variables have to be set in the repository settings.
## Input parameters
Input parameter | Description | Required | Default