mirror of
https://github.com/sebastianpopp/ftp-action.git
synced 2024-12-22 18:59:49 +01:00
add readme
This commit is contained in:
parent
83bf24a942
commit
4cd0cd03d0
1 changed files with 34 additions and 1 deletions
33
README.md
33
README.md
|
@ -1 +1,34 @@
|
|||
# ftp-action
|
||||
|
||||
Automate copying your files via FTP using this GitHub action.
|
||||
|
||||
## Example usage
|
||||
|
||||
```
|
||||
name: Upload via FTP
|
||||
on: push
|
||||
jobs:
|
||||
FTP-Action:
|
||||
name: FTP-Action
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- name: Deploy FTP
|
||||
uses: sebastianpopp/ftp-action@master
|
||||
with:
|
||||
host: "ftp.example.com"
|
||||
user: ${{ secrets.FTP_USERNAME }}
|
||||
password: ${{ secrets.FTP_PASSWORD }}
|
||||
localDir: "dist"
|
||||
remoteDir: "www"
|
||||
```
|
||||
|
||||
## Input parameters
|
||||
|
||||
Input parameter | Description | Required | Default
|
||||
--- | --- | --- | ---
|
||||
host | FTP server name | Yes | N/A
|
||||
user | FTP username | Yes | N/A
|
||||
password | FTP password | Yes | N/A
|
||||
localDir | The local directory to copy | No | .
|
||||
remoteDir | The remote directory to copy to | No | .
|
||||
|
|
Loading…
Reference in a new issue