https://github.com/joutvhu/ftp-transfer
GitHub Action to transfer files to and from a computer running an FTP server service.
https://github.com/joutvhu/ftp-transfer
actions ftp github github-actions transfer
Last synced: about 1 year ago
JSON representation
GitHub Action to transfer files to and from a computer running an FTP server service.
- Host: GitHub
- URL: https://github.com/joutvhu/ftp-transfer
- Owner: joutvhu
- License: mit
- Created: 2023-07-19T05:59:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-28T06:56:46.000Z (over 2 years ago)
- Last Synced: 2025-04-17T02:31:08.426Z (about 1 year ago)
- Topics: actions, ftp, github, github-actions, transfer
- Language: JavaScript
- Homepage:
- Size: 351 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# FTP Transfer
GitHub Action to transfer files to and from a computer running an FTP server service.
## Usage
See [action.yml](action.yml)
## Inputs
- `host`: The hostname or IP address of the FTP server. Required
- `port`: The port of the FTP server. Default: `21`.
- `username`: Username for authentication. Default: `anonymous`
- `password`: Password for authentication. Default: `anonymous@`
- `connTimeout`: How long (in milliseconds) to wait for the control connection to be established. Default: `10000`
- `pasvTimeout`: How long (in milliseconds) to wait for a PASV data connection to be established. Default: `10000`
- `keepalive`: How often (in milliseconds) to send a "dummy" (NOOP) command to keep the connection alive. Default: `10000`
- `commands`: The ftp commands. Required
## Commands
- `ls [path]`: Retrieves the directory listing of `path`. `path` defaults to the current working directory.
- `get `: Retrieves a file or directory at `remote_path` from the server.
- `put `: Sends file or directory to the server to be stored as `remote_path`.
- `append `: Same as `put`, except if file already exists, it will be appended to instead of overwritten.
- `rename `: Renames `old_path` to `new_path` on the server.
- `delete `: Deletes a file or directory on the server.
- `cd `: Changes the current working directory to `path`.
- `pwd `: Retrieves the current working directory.
- `mkdir `: Creates a new directory `path` on the server.
- `rmdir `: Removes a directory `path` on the server.
## Example
```yaml
steps:
- uses: joutvhu/ftp-transfer@v1
with:
host: localhost
port: 21
username: joutvhu
password: ${{ secrets.FTP_PASSWORD }}
commands: |
put ./build ./build.new
rename ./build ./build.old
rename ./build.new ./build
delete ./build.old
```