fastlane-plugin-report 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24300fb623f3a802d1fefbea312158edaf4497c9
-  data.tar.gz: fff42402aa8ff34f669cce057d156fad80b6754a
+  metadata.gz: 127b27e9be3ea12dbce435cf9a686459d5bde5ca
+  data.tar.gz: af6eb611d7fb468a923b3162dfd2d793324f720e
 SHA512:
-  metadata.gz: 42a4c2ae6f8eeaeba51b978884aec6a531ca8c9e16dcebd534ce3685b85fc4f6c19fba8bba3d1047d5d1ec467e3c94fea378ab8e020d6e164943aa0bc4df00d6
-  data.tar.gz: 352f2c88edca3e183aa08b2fa712e190fde45ffd22e608960dc141c4f496ab422888d999e8c6dfc0e97553fa68e9c88271ece5c7a1fe38c1c3c8c979acbebe21
+  metadata.gz: 9f8ba86923d78e1ff1f33176b469f0cdfee9b62dcd33807b8af47b0dcd1869f3a96f97e349d8440a57b1b35f96d7848157a4e81285c8bea7ad2572b9c46e8296
+  data.tar.gz: 44bf6c5eecc6ff6d7e9370d254d0a35743b14fcb2936a5761e6e6c9acb8e9400dee91dbb2bbfc4547812e78ec2f5349e4bf335fad4c14cfe6d1dcdd6ffb2410c

data/README.md

@@ -1,4 +1,4 @@
-# report plugin
+# Report Plugin
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-report)
 
@@ -12,15 +12,33 @@ fastlane add_plugin report
 
 ## About report
 
-This action is responsible to send a report file of what you want to slack (ex. send a scan report to slack).
+After an action, like scan for instance, you're able to generate a report file.
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+This fastlane plugin gives you a way to upload and share your report using Slack.
 
 ## Example
 
-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`.
-
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+See this exemple above:
+
+````ruby
+report(
+    slack_api_token: 'xxxx-0000000-11111111-222222222-xxxxxxxx333333',
+    path: './some/path/report.html',
+    path_type: 'text/html',
+    file_name: 'report.html'
+)
+````
+
+Parameter | Description | Mandatory | Environment
+--------- | ----------- | --------- | -----------
+`slack_api_token` | Token of slack rest api. Need to be generated at https://api.slack.com | true | `REPORT_SLACK_API_TOKEN`
+`path` | Relative path to report file (ex. ./reports/20170603140211.html) | true | `REPORT_PATH`
+`path_type` | Multipart type of your report file (ex. text/html) | true | `REPORT_PATH_TYPE`
+`file_name` | Name of your file (ex. 20170603140211.html) | true | `REPORT_FILE_NAME`
+`channels` | Selected channels to upload and post your report (default: #channel) | false | `REPORT_SLACK_CHANNELS`
+`title` | Title that will be shown on Slack | false | `REPORT_TITLE`
+`message` | Message that will be shown on Slack | false | `REPORT_MESSAGE`
+`scan_as_pdf` | File that will be sent to Slack (default: `true` if was a HTML file) | false | `REPORT_SCAN_AS_PDF`
 
 ## Run tests for this plugin
 
@@ -39,6 +57,8 @@ rubocop -a
 
 For any other issues and feedback about this plugin, please submit it to this repository.
 
+**NOTE:** Feel free to give feedback or report some bugs or even contribute with some code.
+
 ## Troubleshooting
 
 If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.

data/lib/fastlane/plugin/report/actions/report_action.rb

@@ -95,8 +95,8 @@ module Fastlane
             path: './some/path/report.html',
             path_type: 'text/html',
             file_name: 'report.html'
-          )"
-          "",
+          )",
+          ""
         ].join('\n')
       end
 

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

@@ -1,6 +1,6 @@
 module Fastlane
   module Report
-    VERSION = "0.1.12"
+    VERSION = "0.2.0"
   	DESCRIPTION = "Try to fix a bug on installation process."
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-report
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors:
 - Bruno Miguêns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pdfkit
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +176,7 @@ files:
 - lib/fastlane/plugin/report/actions/report_action.rb
 - lib/fastlane/plugin/report/helper/report_helper.rb
 - lib/fastlane/plugin/report/version.rb
-homepage: https://github.com/BrunoMiguens/report
+homepage: https://github.com/BrunoMiguens/fastlane-plugin-report
 licenses:
 - MIT
 metadata: {}
@@ -174,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -186,6 +200,6 @@ rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: After an action, like scan for instance, you're able to generate a report
-  file.\nThis fastlane plugin gives you a way to upload and share your report using
+  file. This fastlane plugin gives you a way to upload and share your report using
   Slack.
 test_files: []