fastlane-plugin-dropbox

Fastlane Dropbox plugin

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-dropbox, add it to your project by running:

fastlane add_plugin dropbox

About

This plugin allows for uploading files to Dropbox from Fastlane, using provided Dropbox client application.

Requirements

This plugin relies on MacOS keychain (for storing your Dropbox access token), hence it would work only on MacOS at the moment.

Setting up

Note: Dropbox allows accessing their API only for authorized applications, so in order to use this plugin you must register a Dropbox app.

In order to register a Dropbox app you need to go to Dropbox Developers site and create your own app.

Using access token

• For Fastlane you only need the access token (or the app key and app secret). You'll also have to come up with some name for the app, but this is not used by Fastlane in any way.
• You also don't need to apply for production state of your app, and keep it in development phase unless you make heavy use of it. Even Dropbox themselves encourage staying in development state when the app is used as an internal tool. Read more here.
• You start with access for one user only, but in development state you can request access for up to 500 users, which should cover most of the use cases for Fastlane integration.

Example

Basic usage

Using access token:

dropbox(
    file_path: '/some/local-path/to/file.txt',
    dropbox_path: '/path/to/Dropbox/destination/folder',
    access_token: 'your-dropbox-access-token'
)

Using app key and app secret:

dropbox(
    file_path: '/some/local-path/to/file.txt',
    dropbox_path: '/path/to/Dropbox/destination/folder',
    app_key: 'your-dropbox-app-key',
    app_secret: 'your-dropbox-app-secret'
)

The dropbox_path parameter is optional - if not provided, the file at file_path would be put in the Dropbox root directory.

Write modes

The default write_mode is add, which means that plugin will raise an error if the file already exists at the destination path. If you want to allow for overwriting, set the write_mode parameter like so:

dropbox(
    file_path: '/some/local-path/to/file.txt',
    dropbox_path: '/path/to/Dropbox/destination/folder',
    write_mode: 'overwrite',
    access_token: 'your-dropbox-access-token'
)

For the more fine-grained overwriting you can set the update write mode, and pass the current file revision to update:

dropbox(
    file_path: '/some/local-path/to/file.txt',
    dropbox_path: '/path/to/Dropbox/destination/folder',
    write_mode: 'update',
    update_rev: 'filerevisiontoupdate',
    access_token: 'your-dropbox-access-token'
)

The update_rev parameter is required for update write mode and ignored in other cases. Currently, if the current file revision on Dropbox doesn't match the provided revision, the plugin will fail (Dropbox API won't allow for the update).

Run tests for this plugin

To run both the tests, and code style validation, run

rake

To automatically fix many of the styling issues, use

rubocop -a

Issues and Feedback

For any other issues and feedback about this plugin, please submit it to this repository.

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting guide.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

About fastlane

fastlane is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out fastlane.tools.