https://github.com/wei/rclone
Wraps the rclone CLI to be used in Github Actions
https://github.com/wei/rclone
action github-action rclone
Last synced: about 1 year ago
JSON representation
Wraps the rclone CLI to be used in Github Actions
- Host: GitHub
- URL: https://github.com/wei/rclone
- Owner: wei
- Created: 2019-07-17T18:29:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-29T15:21:41.000Z (almost 7 years ago)
- Last Synced: 2025-04-30T08:14:02.766Z (about 1 year ago)
- Topics: action, github-action, rclone
- Language: Dockerfile
- Size: 4.88 KB
- Stars: 75
- Watchers: 1
- Forks: 33
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-rclone - GitHub Action for rclone - GitHub Action that installs and runs rclone within workflows for syncing artifacts to cloud storage.  (Cloud and System Integrations / CI/CD)
README
# Github Action for rclone
This Action wraps [rclone](https://rclone.org) to enable syncing files and directories to and from different cloud storage providers.
## Features
* "rsync for cloud storage"
* sync to and from different cloud storage providers
* backup files or deploy artifacts to remote storage
## Usage
### Github Actions
```
on: push
jobs:
rclone:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: rclone
uses: wei/rclone@v1
env:
RCLONE_CONF: ${{ secrets.RCLONE_CONF }}
with:
args: copy : :
```
`RCLONE_CONF` can be omitted if [CLI arguments](https://rclone.org/flags/#backend-flags) or [environment variables](https://rclone.org/docs/#environment-variables) are supplied. `RCLONE_CONF` can also be encrypted if [`RCLONE_CONFIG_PASS`](https://rclone.org/docs/#configuration-encryption) secret is supplied.
### Docker
```
docker run --rm -e "RCLONE_CONF=$(cat ~/.config/rclone/rclone.conf)" $(docker build -q .) \
copy : :
```
## Author
[Wei He](https://github.com/wei) _github@weispot.com_
## License
[MIT](https://wei.mit-license.org)