From 1741501f112f30331672892b44903dd32d4abaf6 Mon Sep 17 00:00:00 2001 From: ViViDboarder Date: Wed, 11 Apr 2018 17:26:31 -0700 Subject: [PATCH] Add readme --- Readme.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..66c3688 --- /dev/null +++ b/Readme.md @@ -0,0 +1,31 @@ +# drone-webdav +*A WebDAV plugin for the drone.io project* + +The WebDAV plugin will allow pushing build artifacts to any WebDAV server, including Nextcloud or ownCloud. + +An example configuration would be as follows: + +```yaml +pipeline: + upload_debug: + image: vividboarder/drone-webdav + file: com.vividboarder.otbeta/build/outputs/apk/com.vividboarder.otbeta-debug.apk + destination: https://my.nextcloud.com/remote.php/dav/files/vividboarder/Android/Apks/ + user: myusername + password: mypassword +``` + +You probably don't want to check your credentials into your repo, so you may use secrets for this: + +```yaml +pipeline: + upload_debug: + image: vividboarder/drone-webdav + file: com.vividboarder.otbeta/build/outputs/apk/com.vividboarder.otbeta-debug.apk + destination: https://my.nextcloud.com/remote.php/dav/files/vividboarder/Android/Apks/ + secrets: + - source: WEBDAV_USER + target: PLUGIN_USERNAME + - source: WEBDAV_PASSWORD + target: PLUGIN_PASSWORD +```