fastlane-plugin-applivery 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 895250d53aaf099a8cfccf51232cb63bcb8b56fc
-  data.tar.gz: 656518136abdabdbed4558adf86fad9d509f139b
+  metadata.gz: 694da3223547e78c1679e59c3bcb793114f5993a
+  data.tar.gz: 20ec53551af54d699b74e06c3393c6d7381da2c3
 SHA512:
-  metadata.gz: 89653f3259fa0def93ba5e69bc22728f0696f3f78df54470f98e40306b1e11c146ed7f86c5d96a24fc6960d622e173c472d62d23bb06b8b181969928e2d090ee
-  data.tar.gz: 6ed4a7e3d1f088332f5524cc7fda63735765c4ea1145ad14b0d8700a54a5e63dc0de08f876da15abeba6b64ae628c876b3598b0cad2bd2241a22b81670217907
+  metadata.gz: 25b0f1fec56f8cb3d17f53f3c5e80ad82202efe4003e84215225dc5eaa0de4c597e21757ad69c6af38a6934fbb89754fdee331bf95d5e374b1218bf236728ce5
+  data.tar.gz: fbce9fe9bc31195abd9e3c2147958b4755df7f1e7bbf93748ba1c3e33df20b615eaa7923411732f15407e1be00936aea3df111fa2b3d5770982a402cb77a3ebe

data/README.md

@@ -1,4 +1,4 @@
-# applivery plugin
+# Fastlane Applivery plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-applivery)
 [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-applivery.svg)](https://badge.fury.io/rb/fastlane-plugin-applivery)
@@ -11,15 +11,62 @@ This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To ge
 fastlane add_plugin applivery
 ```
 
-## About applivery
+## About Applivery.com
 
-Upload new build to Applivery
+With [Applivery.com](https://www.applivery.com) you can easily distribute your iOS and Android Apps throughout a customizable platform with no need of your users have to be registered on it.
 
+**The main purpose of this plugin is to upload a new iOS or Android build to [Applivery.com](https://www.applivery.com).**
 
-## Example
+If you usually use Fastlane tools to automate the most common development tasks now you can start using out Fastlane Plugin to easily deploy new iOS and Android versions of your Apps to Applivery and close your development the cycle: Build, Test & deploy like a pro!
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`. 
+This **fastlane** plugin will also help you to have more context about the build, attaching and displaying the most relevant information: Direct link to the repository(GitHub & Bitbucket), commit hash, Branch, Tag, etc:
 
+![List of builds](http://www.applivery.com/wp-content/uploads/2016/08/BuildsList.png)
+![Build details](http://www.applivery.com/wp-content/uploads/2016/08/BuilInfo.png)
+
+## Examples
+
+Below you'll find some basic examples about how to **build** a new iOS or Android App and automatically **deploy** it into Applivery.com
+
+### iOS App build and deploy
+Next you'll find a `lane` with two steps: `gym()` that will build the iOS App and `applivery()` that will take care about the deployment.
+```ruby
+lane :applivery_ios do
+  gym(
+    scheme: "YOUR_APP_SCHEME",        # Your App Scheme
+    export_method: 'enterprise')      # Choose between: enterprise or ad-hoc
+  applivery(
+    app_id: "YOUR_APP_ID",            # Your Applivery App Id
+    api_key: "YOUR_API_KEY"           # Your Applivery API Key
+  )
+end
+```
+### Android App build and deploy
+Next you'll find a `lane` with two steps: `gradle()` that will build the Android App and `applivery()` that will take care about the deployment.
+```ruby
+lane :applivery_android do
+  gradle(task: "assembleRelease")
+  applivery(
+    app_id: "YOUR_APP_ID",           # Your Applivery App Id
+    api_key: "YOUR_API_KEY"          # Your Applivery API Key
+  )
+end
+```
+Please check out the [example `Fastfile`](fastlane/Fastfile) to see additional examples of how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`. 
+
+## Additional Parameters
+The above examples are the most simple configuration you can have but in addition to the `app_id` and `api_key` parameters, you can add additional ones to fully customize the deployment process. They are:
+
+| Param       | Description                 | Mandatory | Values       |
+|-------------|-----------------------------|-----------|--------------|
+| `app_id`    | Applivery App ID            | YES       | string -> Available in the App details |
+| `api_key`   | Applivery API Key           | YES       | string -> Available the [Developers](https://dashboard.applivery.com/dashboard/developers) area       |
+| `name`      | Applivery Build name        | NO        | string. i.e.: "RC 1.0"       |
+| `notify`    | Notify users after deploy   | NO        | true / false |
+| `notes`     | Release notes               | NO        | string. i.e.: "Bug fixing"       |
+| `tags`      | Tags to identify the build  | NO        | string comma separated. i.e.: "RC1, QA" |
+| `autoremove`| Remove the last build       | NO        | true / false |
+| `build_path`| Build path to the APK / IPA file  | NO  | string, by default it takes the IPA/APK build path |
 
 ## Run tests for this plugin
 
@@ -36,7 +83,7 @@ rubocop -a
 
 ## Issues and Feedback
 
-For any other issues and feedback about this plugin, please submit it to this repository.
+For any other issues and feedback about this plugin, please submit it to this repository or contact us at [support@applivery.com](mailto:support@applivery.com)
 
 ## Troubleshooting
 

data/lib/fastlane/plugin/applivery/actions/applivery_action.rb

@@ -10,6 +10,7 @@ module Fastlane
         tags = params[:tags]
         build_path = params[:build_path]
         notify = params[:notify]
+        autoremove = params[:autoremove]
         os = Helper::AppliveryHelper.platform
 
         command = "curl \"https://dashboard.applivery.com/api/builds\""
@@ -18,6 +19,7 @@ module Fastlane
         command += " -F versionName=\"#{name}\""
         command += " -F notes=\"#{notes}\""
         command += " -F notify=#{notify}"
+        command += " -F autoremove=#{autoremove}"
         command += " -F os=#{os}"
         command += " -F tags=\"#{tags}\""
         command += " -F deployer=fastlane"
@@ -91,6 +93,13 @@ module Fastlane
             description: "Send an email to your users",
             default_value: true,
             optional: true,
+            is_string: false),
+
+          FastlaneCore::ConfigItem.new(key: :autoremove,
+            env_name: "APPLIVERY_AUTOREMOVE",
+            description: "Automatically remove your application's oldest build",
+            default_value: true,
+            optional: true,
             is_string: false)
         ]
       end
@@ -111,8 +120,7 @@ module Fastlane
         [
           'applivery(
             app_id: "YOUR_APP_ID",
-            api_key: "YOUR_APP_SECRET",
-            name: "YOUR_BUILD_NAME")'
+            api_key: "YOUR_APP_SECRET")'
         ]
       end
 

data/lib/fastlane/plugin/applivery/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Applivery
-    VERSION = "1.0"
+    VERSION = "1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-applivery
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Alejandro Jimenez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry