fastlane-plugin-branch 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd7832dada7bafc5f835e46ad4d1e0c0c7dd80b8e2c0922d38fd3d3654914e5e
-  data.tar.gz: 2d7d4984f13d213bfcd9323e348e2f3b4d9c968e2ec17032f4c7c00db19d1c29
+  metadata.gz: c0bf0882b0ede08d7b90ef0afe3fec1b529658d9913890934e75d1c19ac0e7ac
+  data.tar.gz: 2f5c6b41e118d1316e862fc183d20c739204087dca85d7c5bd238e1c86d97a3e
 SHA512:
-  metadata.gz: fb23965662dd76e788bc1b4b772c64c25a77a8855cf89ea62515e0ba139ed11210ea49bd3432c48f79a1453a313674b0b180ef8913105005ca4e7296f2dd743e
-  data.tar.gz: 99decd40419463d24ff542674a94b0db994adc9821fe241cd067cf8eb172370e96998c5494bdb1b29db26ae9e5dbbd0d7e6ad1210b319a7209bd93fb2de0578f
+  metadata.gz: 9c281230953b7ccbd3f56bca4376c33adb4fb2cd6227665d94ed44720d23b0e66fd8f5f23de848e79b7c1b589178b93f800e2f9c8c3eafe70e577a602d720771
+  data.tar.gz: da24b07b31d0dc19d1d20b0be1b33c4ae5dcbfb32b1e0ae5b59a2b50dce61a755f4548c3b7d96044452aa46d4eb6c3d5df9cbb5f1901b7a5cddbdd4cf47e841a

data/README.md

@@ -46,14 +46,14 @@ location.
 
 If a Podfile or Cartfile is detected, the Branch SDK will be added to the relevant
 configuration file and the dependencies updated to include the Branch framework.
-This behavior may be suppressed using `no_add_sdk`. If no Podfile or Cartfile
+This behavior may be suppressed using `add_sdk: false`. If no Podfile or Cartfile
 is found, and Branch.framework is not already among the project's dependencies,
 you will be prompted for a number of choices, including setting up CocoaPods or
 Carthage for the project or directly installing the Branch.framework.
 
 By default, all supplied Universal Link domains are validated. If validation passes,
 the setup continues. If validation fails, no further action is taken. Suppress
-validation using `no_validate` or force changes when validation fails using
+validation using `validate: false` or force changes when validation fails using
 `force`.
 
 By default, this command will look for the first app target in the project. Test
@@ -67,7 +67,7 @@ Optionally, if `frameworks` is specified, this command can add a list of system
 frameworks to the target's dependencies (e.g., AdSupport, CoreSpotlight, SafariServices).
 
 A language-specific patch is applied to the AppDelegate (Swift or Objective-C).
-This can be suppressed using `no_patch_source`.
+This can be suppressed using `patch_source: false`.
 
 #### Prerequisites
 
@@ -79,7 +79,7 @@ for details. To use the `setup` command, you need:
 - Domain name(s) used for Branch links
 - Location of your Xcode project (may be inferred in simple projects)
 
-If using the `commit` option, `git` is required. If not using `no_add_sdk`,
+If using the `commit` option, `git` is required. If not using `add_sdk: false`,
 the `pod` or `carthage` command may be required. If not found, the CLI will
 offer to install and set up these command-line tools for you. Alternately, you can arrange
 that the relevant commands are available in your `PATH`.
@@ -96,26 +96,26 @@ See https://github.com/BranchMetrics/branch_io_cli#setup-command for more inform
 
 |Fastfile key|description|Environment variable|type|default value|
 |---|---|---|---|---|
-|live_key|Branch live key|BRANCH_LIVE_KEY|Boolean||
-|test_key|Branch test key|BRANCH_TEST_KEY|Boolean||
-|domains|Comma-separated list of custom domain(s) or non-Branch domain(s)|BRANCH_DOMAINS|Boolean||
-|app_link_subdomain|Branch app.link subdomain, e.g. myapp for myapp.app.link|BRANCH_APP_LINK_SUBDOMAIN|Boolean||
-|uri_scheme|Custom URI scheme used in the Branch Dashboard for this app|BRANCH_URI_SCHEME|Boolean||
-|setting|Use a custom build setting for the Branch key (default: Use Info.plist)|BRANCH_SETTING|Boolean||
-|test_configurations|List of configurations that use the test key with a user-defined setting (default: Debug configurations)|BRANCH_TEST_CONFIGURATIONS|Boolean||
-|xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|Boolean||
-|target|Name of a target to modify in the Xcode project|BRANCH_TARGET|Boolean||
-|podfile|Path to the Podfile for the project|BRANCH_PODFILE|Boolean||
-|cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|Boolean||
-|carthage_command|Command to run when installing from Carthage|BRANCH_CARTHAGE_COMMAND|Boolean|update --platform ios|
-|frameworks|Comma-separated list of system frameworks to add to the project|BRANCH_FRAMEWORKS|Boolean||
-|pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE||true|
-|validate|Validate Universal Link configuration|BRANCH_VALIDATE||true|
-|force|Update project even if Universal Link validation fails|BRANCH_FORCE||false|
-|add_sdk|Add the Branch framework to the project|BRANCH_ADD_SDK||true|
-|patch_source|Add Branch SDK calls to the AppDelegate|BRANCH_PATCH_SOURCE||true|
-|commit|Commit the results to Git if non-blank|BRANCH_COMMIT|Boolean||
-|confirm|Confirm configuration before proceeding|BRANCH_CONFIRM||true|
+|live_key|Branch live key|BRANCH_LIVE_KEY|String||
+|test_key|Branch test key|BRANCH_TEST_KEY|String||
+|domains|Comma-separated list of custom domain(s) or non-Branch domain(s)|BRANCH_DOMAINS|Array||
+|app_link_subdomain|Branch app.link subdomain, e.g. myapp for myapp.app.link|BRANCH_APP_LINK_SUBDOMAIN|String||
+|uri_scheme|Custom URI scheme used in the Branch Dashboard for this app|BRANCH_URI_SCHEME|String||
+|setting|Use a custom build setting for the Branch key (default: Use Info.plist)|BRANCH_SETTING|String||
+|test_configurations|List of configurations that use the test key with a user-defined setting (default: Debug configurations)|BRANCH_TEST_CONFIGURATIONS|Array||
+|xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|String||
+|target|Name of a target to modify in the Xcode project|BRANCH_TARGET|String||
+|podfile|Path to the Podfile for the project|BRANCH_PODFILE|String||
+|cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|String||
+|carthage_command|Command to run when installing from Carthage|BRANCH_CARTHAGE_COMMAND|String|update --platform ios|
+|frameworks|Comma-separated list of system frameworks to add to the project|BRANCH_FRAMEWORKS|Array||
+|pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE|Boolean|true|
+|validate|Validate Universal Link configuration|BRANCH_VALIDATE|Boolean|true|
+|force|Update project even if Universal Link validation fails|BRANCH_FORCE|Boolean|false|
+|add_sdk|Add the Branch framework to the project|BRANCH_ADD_SDK|Boolean|true|
+|patch_source|Add Branch SDK calls to the AppDelegate|BRANCH_PATCH_SOURCE|Boolean|true|
+|commit|Commit the results to Git if non-blank|BRANCH_COMMIT|String||
+|confirm|Confirm configuration before proceeding|BRANCH_CONFIRM|Boolean|true|
 
 
 #### Examples
@@ -151,11 +151,17 @@ Only app targets are supported for this command. By default, it will validate th
 If your project has multiple app targets, specify the `target` option to validate other
 targets.
 
-All parameters are optional. If `domains` is specified, the list of Universal Link domains in
-the Associated Domains entitlement must exactly match this list, without regard to order. If
-no `domains` are provided, validation passes if at least one Universal Link domain is
-configured and passes validation, and no Universal Link domain is present that does not pass
-validation.
+By default, all build configurations in the project are validated. To validate a different list
+of configurations, including a single configuration, specify the `configurations` option.
+
+If `domains` is specified, the list of Universal Link domains in the Associated
+Domains entitlement must exactly match this list, without regard to order, for all
+configurations under validation. If no `domains` are provided, validation passes
+if at least one Universal Link domain is configured for each configuration and passes
+validation, and no Universal Link domain is present in anyconfiguration that does not
+pass validation.
+
+All parameters are optional.
 
 See https://github.com/BranchMetrics/branch_io_cli#validate-command for more information.
 
@@ -164,9 +170,10 @@ See https://github.com/BranchMetrics/branch_io_cli#validate-command for more inf
 
 |Fastfile key|description|Environment variable|type|default value|
 |---|---|---|---|---|
-|domains|Comma-separated list of domains to validate (Branch domains or non-Branch domains)|BRANCH_DOMAINS|Boolean|[]|
-|xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|Boolean||
-|target|Name of a target to validate in the Xcode project|BRANCH_TARGET|Boolean||
+|domains|Comma-separated list of domains to validate (Branch domains or non-Branch domains)|BRANCH_DOMAINS|Array|[]|
+|xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|String||
+|target|Name of a target to validate in the Xcode project|BRANCH_TARGET|String||
+|configurations|Comma-separated list of configurations to validate (default: all)|BRANCH_CONFIGURATIONS|Array||
 
 
 #### Examples
@@ -197,28 +204,44 @@ validate_universal_links(domains: %w{example.com www.example.com})
 branch_report
 ```
 
-_Work in progress_
-
 This command optionally cleans and then builds a workspace or project, generating a verbose
 report with additional diagnostic information suitable for opening a support ticket.
 
+Use the `header_only` option to output only a brief diagnostic report without
+building.
+
 
 #### Options
 
 |Fastfile key|description|Environment variable|type|default value|
 |---|---|---|---|---|
-|workspace|Path to an Xcode workspace|BRANCH_WORKSPACE|Boolean||
-|xcodeproj|Path to an Xcode project|BRANCH_XCODEPROJ|Boolean||
-|scheme|A scheme from the project or workspace to build|BRANCH_SCHEME|Boolean||
-|target|A target to build|BRANCH_TARGET|Boolean||
-|configuration|The build configuration to use (default: Scheme-dependent)|BRANCH_CONFIGURATION|Boolean||
-|sdk|Passed as -sdk to xcodebuild|BRANCH_SDK|Boolean|iphonesimulator|
-|podfile|Path to the Podfile for the project|BRANCH_PODFILE|Boolean||
-|cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|Boolean||
-|clean|Clean before attempting to build|BRANCH_CLEAN||true|
-|header_only|Write a report header to standard output and exit|BRANCH_HEADER_ONLY||false|
-|pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE||true|
-|out|Report output path|BRANCH_REPORT_PATH|Boolean|./report.txt|
+|workspace|Path to an Xcode workspace|BRANCH_WORKSPACE|String||
+|xcodeproj|Path to an Xcode project|BRANCH_XCODEPROJ|String||
+|scheme|A scheme from the project or workspace to build|BRANCH_SCHEME|String||
+|target|A target to build|BRANCH_TARGET|String||
+|configuration|The build configuration to use (default: Scheme-dependent)|BRANCH_CONFIGURATION|String||
+|sdk|Passed as -sdk to xcodebuild|BRANCH_SDK|String|iphonesimulator|
+|podfile|Path to the Podfile for the project|BRANCH_PODFILE|String||
+|cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|String||
+|clean|Clean before attempting to build|BRANCH_CLEAN|Boolean|true|
+|header_only|Write a report header to standard output and exit|BRANCH_HEADER_ONLY|Boolean|false|
+|pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE|Boolean|true|
+|out|Report output path|BRANCH_REPORT_PATH|String|./report.txt|
+
+
+#### Examples
+
+```Ruby
+branch_report
+```
+
+```Ruby
+branch_report(header_only: true)
+```
+
+```Ruby
+branch_report(workspace: "MyWorkspace.xcworkspace")
+```
 
 
 

data/lib/fastlane/plugin/branch/actions/branch_report_action.rb

@@ -15,7 +15,7 @@ module Fastlane
       end
 
       def self.description
-        "TODO"
+        "Generate a brief summary or a full build report for your project."
       end
 
       def self.authors
@@ -31,6 +31,9 @@ module Fastlane
 
       def self.example_code
         [
+          "branch_report",
+          "branch_report(header_only: true)",
+          "branch_report(workspace: \"MyWorkspace.xcworkspace\")"
         ]
       end
 

data/lib/fastlane/plugin/branch/fastlane_format.rb

@@ -2,8 +2,21 @@ require "branch_io_cli/format"
 
 module Fastlane
   module Branch
+    module FastlaneFormat
+      include BranchIOCLI::Format
+      def option(opt)
+        if opt =~ /^no_/
+          opt_text = "#{opt.to_s.sub(/^no_/, '')}: false"
+        else
+          opt_text = opt.to_s
+        end
+        highlight opt_text
+      end
+    end
+
     module FastlaneMarkdownFormat
       include BranchIOCLI::Format::MarkdownFormat
+      include FastlaneFormat
 
       def local_render(template)
         path = File.expand_path(File.join("..", "..", "..", "..", "..", "assets", "templates", "#{template}.erb"), __FILE__)
@@ -11,20 +24,12 @@ module Fastlane
       end
 
       def table_option(option)
-        "|#{option.name}|#{option.description}|#{option.env_name}|#{option.type ? 'Boolean' : option.type}|#{option.default_value}|"
-      end
-
-      def option(opt)
-        highlight opt.to_s
+        "|#{option.name}|#{option.description}|#{option.env_name}|#{option.type.nil? ? 'Boolean' : option.type.name}|#{option.default_value}|"
       end
     end
 
     module FastlaneDescriptionFormat
-      include BranchIOCLI::Format
-
-      def option(opt)
-        highlight opt.to_s
-      end
+      include FastlaneFormat
 
       def highlight(text)
         text

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Branch
-    VERSION = "0.7.2"
+    VERSION = "0.7.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-branch
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: branch_io_cli