2019-09-05 10:56:26 +02:00
|
|
|
# ftp-action
|
|
|
|
|
2019-11-16 18:45:24 +01:00
|
|
|
Automate copying your files via ftp using this GitHub action.
|
2019-09-05 10:56:26 +02:00
|
|
|
|
|
|
|
## Example usage
|
|
|
|
|
|
|
|
```
|
2019-11-16 18:45:24 +01:00
|
|
|
name: Deploy via ftp
|
2019-09-05 10:56:26 +02:00
|
|
|
on: push
|
|
|
|
jobs:
|
2019-11-16 18:45:24 +01:00
|
|
|
deploy:
|
|
|
|
name: Deploy
|
2019-09-05 10:56:26 +02:00
|
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
2020-03-16 10:45:32 +01:00
|
|
|
- uses: actions/checkout@v2
|
2019-11-16 18:45:24 +01:00
|
|
|
- name: Upload ftp
|
2020-03-16 10:45:32 +01:00
|
|
|
uses: sebastianpopp/ftp-action@releases/v2
|
2019-09-05 10:56:26 +02:00
|
|
|
with:
|
2019-11-15 05:49:02 +01:00
|
|
|
host: ${{ secrets.FTP_SERVER }}
|
2019-09-05 10:56:26 +02:00
|
|
|
user: ${{ secrets.FTP_USERNAME }}
|
|
|
|
password: ${{ secrets.FTP_PASSWORD }}
|
|
|
|
localDir: "dist"
|
|
|
|
remoteDir: "www"
|
2021-01-31 20:42:23 +01:00
|
|
|
options: "--delete --asci"
|
2019-09-05 10:56:26 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
## 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 | .
|
2020-03-16 10:45:32 +01:00
|
|
|
forceSsl | Force SSL encryption | No | false
|
2021-01-31 20:42:23 +01:00
|
|
|
options | Mirror command options | No | ''
|