fastlane-plugin-branch 0.7.2 → 0.7.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bd7832dada7bafc5f835e46ad4d1e0c0c7dd80b8e2c0922d38fd3d3654914e5e
4
- data.tar.gz: 2d7d4984f13d213bfcd9323e348e2f3b4d9c968e2ec17032f4c7c00db19d1c29
3
+ metadata.gz: c0bf0882b0ede08d7b90ef0afe3fec1b529658d9913890934e75d1c19ac0e7ac
4
+ data.tar.gz: 2f5c6b41e118d1316e862fc183d20c739204087dca85d7c5bd238e1c86d97a3e
5
5
  SHA512:
6
- metadata.gz: fb23965662dd76e788bc1b4b772c64c25a77a8855cf89ea62515e0ba139ed11210ea49bd3432c48f79a1453a313674b0b180ef8913105005ca4e7296f2dd743e
7
- data.tar.gz: 99decd40419463d24ff542674a94b0db994adc9821fe241cd067cf8eb172370e96998c5494bdb1b29db26ae9e5dbbd0d7e6ad1210b319a7209bd93fb2de0578f
6
+ metadata.gz: 9c281230953b7ccbd3f56bca4376c33adb4fb2cd6227665d94ed44720d23b0e66fd8f5f23de848e79b7c1b589178b93f800e2f9c8c3eafe70e577a602d720771
7
+ data.tar.gz: da24b07b31d0dc19d1d20b0be1b33c4ae5dcbfb32b1e0ae5b59a2b50dce61a755f4548c3b7d96044452aa46d4eb6c3d5df9cbb5f1901b7a5cddbdd4cf47e841a
data/README.md CHANGED
@@ -46,14 +46,14 @@ location.
46
46
 
47
47
  If a Podfile or Cartfile is detected, the Branch SDK will be added to the relevant
48
48
  configuration file and the dependencies updated to include the Branch framework.
49
- This behavior may be suppressed using `no_add_sdk`. If no Podfile or Cartfile
49
+ This behavior may be suppressed using `add_sdk: false`. If no Podfile or Cartfile
50
50
  is found, and Branch.framework is not already among the project's dependencies,
51
51
  you will be prompted for a number of choices, including setting up CocoaPods or
52
52
  Carthage for the project or directly installing the Branch.framework.
53
53
 
54
54
  By default, all supplied Universal Link domains are validated. If validation passes,
55
55
  the setup continues. If validation fails, no further action is taken. Suppress
56
- validation using `no_validate` or force changes when validation fails using
56
+ validation using `validate: false` or force changes when validation fails using
57
57
  `force`.
58
58
 
59
59
  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
67
67
  frameworks to the target's dependencies (e.g., AdSupport, CoreSpotlight, SafariServices).
68
68
 
69
69
  A language-specific patch is applied to the AppDelegate (Swift or Objective-C).
70
- This can be suppressed using `no_patch_source`.
70
+ This can be suppressed using `patch_source: false`.
71
71
 
72
72
  #### Prerequisites
73
73
 
@@ -79,7 +79,7 @@ for details. To use the `setup` command, you need:
79
79
  - Domain name(s) used for Branch links
80
80
  - Location of your Xcode project (may be inferred in simple projects)
81
81
 
82
- If using the `commit` option, `git` is required. If not using `no_add_sdk`,
82
+ If using the `commit` option, `git` is required. If not using `add_sdk: false`,
83
83
  the `pod` or `carthage` command may be required. If not found, the CLI will
84
84
  offer to install and set up these command-line tools for you. Alternately, you can arrange
85
85
  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
96
96
 
97
97
  |Fastfile key|description|Environment variable|type|default value|
98
98
  |---|---|---|---|---|
99
- |live_key|Branch live key|BRANCH_LIVE_KEY|Boolean||
100
- |test_key|Branch test key|BRANCH_TEST_KEY|Boolean||
101
- |domains|Comma-separated list of custom domain(s) or non-Branch domain(s)|BRANCH_DOMAINS|Boolean||
102
- |app_link_subdomain|Branch app.link subdomain, e.g. myapp for myapp.app.link|BRANCH_APP_LINK_SUBDOMAIN|Boolean||
103
- |uri_scheme|Custom URI scheme used in the Branch Dashboard for this app|BRANCH_URI_SCHEME|Boolean||
104
- |setting|Use a custom build setting for the Branch key (default: Use Info.plist)|BRANCH_SETTING|Boolean||
105
- |test_configurations|List of configurations that use the test key with a user-defined setting (default: Debug configurations)|BRANCH_TEST_CONFIGURATIONS|Boolean||
106
- |xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|Boolean||
107
- |target|Name of a target to modify in the Xcode project|BRANCH_TARGET|Boolean||
108
- |podfile|Path to the Podfile for the project|BRANCH_PODFILE|Boolean||
109
- |cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|Boolean||
110
- |carthage_command|Command to run when installing from Carthage|BRANCH_CARTHAGE_COMMAND|Boolean|update --platform ios|
111
- |frameworks|Comma-separated list of system frameworks to add to the project|BRANCH_FRAMEWORKS|Boolean||
112
- |pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE||true|
113
- |validate|Validate Universal Link configuration|BRANCH_VALIDATE||true|
114
- |force|Update project even if Universal Link validation fails|BRANCH_FORCE||false|
115
- |add_sdk|Add the Branch framework to the project|BRANCH_ADD_SDK||true|
116
- |patch_source|Add Branch SDK calls to the AppDelegate|BRANCH_PATCH_SOURCE||true|
117
- |commit|Commit the results to Git if non-blank|BRANCH_COMMIT|Boolean||
118
- |confirm|Confirm configuration before proceeding|BRANCH_CONFIRM||true|
99
+ |live_key|Branch live key|BRANCH_LIVE_KEY|String||
100
+ |test_key|Branch test key|BRANCH_TEST_KEY|String||
101
+ |domains|Comma-separated list of custom domain(s) or non-Branch domain(s)|BRANCH_DOMAINS|Array||
102
+ |app_link_subdomain|Branch app.link subdomain, e.g. myapp for myapp.app.link|BRANCH_APP_LINK_SUBDOMAIN|String||
103
+ |uri_scheme|Custom URI scheme used in the Branch Dashboard for this app|BRANCH_URI_SCHEME|String||
104
+ |setting|Use a custom build setting for the Branch key (default: Use Info.plist)|BRANCH_SETTING|String||
105
+ |test_configurations|List of configurations that use the test key with a user-defined setting (default: Debug configurations)|BRANCH_TEST_CONFIGURATIONS|Array||
106
+ |xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|String||
107
+ |target|Name of a target to modify in the Xcode project|BRANCH_TARGET|String||
108
+ |podfile|Path to the Podfile for the project|BRANCH_PODFILE|String||
109
+ |cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|String||
110
+ |carthage_command|Command to run when installing from Carthage|BRANCH_CARTHAGE_COMMAND|String|update --platform ios|
111
+ |frameworks|Comma-separated list of system frameworks to add to the project|BRANCH_FRAMEWORKS|Array||
112
+ |pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE|Boolean|true|
113
+ |validate|Validate Universal Link configuration|BRANCH_VALIDATE|Boolean|true|
114
+ |force|Update project even if Universal Link validation fails|BRANCH_FORCE|Boolean|false|
115
+ |add_sdk|Add the Branch framework to the project|BRANCH_ADD_SDK|Boolean|true|
116
+ |patch_source|Add Branch SDK calls to the AppDelegate|BRANCH_PATCH_SOURCE|Boolean|true|
117
+ |commit|Commit the results to Git if non-blank|BRANCH_COMMIT|String||
118
+ |confirm|Confirm configuration before proceeding|BRANCH_CONFIRM|Boolean|true|
119
119
 
120
120
 
121
121
  #### Examples
@@ -151,11 +151,17 @@ Only app targets are supported for this command. By default, it will validate th
151
151
  If your project has multiple app targets, specify the `target` option to validate other
152
152
  targets.
153
153
 
154
- All parameters are optional. If `domains` is specified, the list of Universal Link domains in
155
- the Associated Domains entitlement must exactly match this list, without regard to order. If
156
- no `domains` are provided, validation passes if at least one Universal Link domain is
157
- configured and passes validation, and no Universal Link domain is present that does not pass
158
- validation.
154
+ By default, all build configurations in the project are validated. To validate a different list
155
+ of configurations, including a single configuration, specify the `configurations` option.
156
+
157
+ If `domains` is specified, the list of Universal Link domains in the Associated
158
+ Domains entitlement must exactly match this list, without regard to order, for all
159
+ configurations under validation. If no `domains` are provided, validation passes
160
+ if at least one Universal Link domain is configured for each configuration and passes
161
+ validation, and no Universal Link domain is present in anyconfiguration that does not
162
+ pass validation.
163
+
164
+ All parameters are optional.
159
165
 
160
166
  See https://github.com/BranchMetrics/branch_io_cli#validate-command for more information.
161
167
 
@@ -164,9 +170,10 @@ See https://github.com/BranchMetrics/branch_io_cli#validate-command for more inf
164
170
 
165
171
  |Fastfile key|description|Environment variable|type|default value|
166
172
  |---|---|---|---|---|
167
- |domains|Comma-separated list of domains to validate (Branch domains or non-Branch domains)|BRANCH_DOMAINS|Boolean|[]|
168
- |xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|Boolean||
169
- |target|Name of a target to validate in the Xcode project|BRANCH_TARGET|Boolean||
173
+ |domains|Comma-separated list of domains to validate (Branch domains or non-Branch domains)|BRANCH_DOMAINS|Array|[]|
174
+ |xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|String||
175
+ |target|Name of a target to validate in the Xcode project|BRANCH_TARGET|String||
176
+ |configurations|Comma-separated list of configurations to validate (default: all)|BRANCH_CONFIGURATIONS|Array||
170
177
 
171
178
 
172
179
  #### Examples
@@ -197,28 +204,44 @@ validate_universal_links(domains: %w{example.com www.example.com})
197
204
  branch_report
198
205
  ```
199
206
 
200
- _Work in progress_
201
-
202
207
  This command optionally cleans and then builds a workspace or project, generating a verbose
203
208
  report with additional diagnostic information suitable for opening a support ticket.
204
209
 
210
+ Use the `header_only` option to output only a brief diagnostic report without
211
+ building.
212
+
205
213
 
206
214
  #### Options
207
215
 
208
216
  |Fastfile key|description|Environment variable|type|default value|
209
217
  |---|---|---|---|---|
210
- |workspace|Path to an Xcode workspace|BRANCH_WORKSPACE|Boolean||
211
- |xcodeproj|Path to an Xcode project|BRANCH_XCODEPROJ|Boolean||
212
- |scheme|A scheme from the project or workspace to build|BRANCH_SCHEME|Boolean||
213
- |target|A target to build|BRANCH_TARGET|Boolean||
214
- |configuration|The build configuration to use (default: Scheme-dependent)|BRANCH_CONFIGURATION|Boolean||
215
- |sdk|Passed as -sdk to xcodebuild|BRANCH_SDK|Boolean|iphonesimulator|
216
- |podfile|Path to the Podfile for the project|BRANCH_PODFILE|Boolean||
217
- |cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|Boolean||
218
- |clean|Clean before attempting to build|BRANCH_CLEAN||true|
219
- |header_only|Write a report header to standard output and exit|BRANCH_HEADER_ONLY||false|
220
- |pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE||true|
221
- |out|Report output path|BRANCH_REPORT_PATH|Boolean|./report.txt|
218
+ |workspace|Path to an Xcode workspace|BRANCH_WORKSPACE|String||
219
+ |xcodeproj|Path to an Xcode project|BRANCH_XCODEPROJ|String||
220
+ |scheme|A scheme from the project or workspace to build|BRANCH_SCHEME|String||
221
+ |target|A target to build|BRANCH_TARGET|String||
222
+ |configuration|The build configuration to use (default: Scheme-dependent)|BRANCH_CONFIGURATION|String||
223
+ |sdk|Passed as -sdk to xcodebuild|BRANCH_SDK|String|iphonesimulator|
224
+ |podfile|Path to the Podfile for the project|BRANCH_PODFILE|String||
225
+ |cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|String||
226
+ |clean|Clean before attempting to build|BRANCH_CLEAN|Boolean|true|
227
+ |header_only|Write a report header to standard output and exit|BRANCH_HEADER_ONLY|Boolean|false|
228
+ |pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE|Boolean|true|
229
+ |out|Report output path|BRANCH_REPORT_PATH|String|./report.txt|
230
+
231
+
232
+ #### Examples
233
+
234
+ ```Ruby
235
+ branch_report
236
+ ```
237
+
238
+ ```Ruby
239
+ branch_report(header_only: true)
240
+ ```
241
+
242
+ ```Ruby
243
+ branch_report(workspace: "MyWorkspace.xcworkspace")
244
+ ```
222
245
 
223
246
 
224
247
 
@@ -15,7 +15,7 @@ module Fastlane
15
15
  end
16
16
 
17
17
  def self.description
18
- "TODO"
18
+ "Generate a brief summary or a full build report for your project."
19
19
  end
20
20
 
21
21
  def self.authors
@@ -31,6 +31,9 @@ module Fastlane
31
31
 
32
32
  def self.example_code
33
33
  [
34
+ "branch_report",
35
+ "branch_report(header_only: true)",
36
+ "branch_report(workspace: \"MyWorkspace.xcworkspace\")"
34
37
  ]
35
38
  end
36
39
 
@@ -2,8 +2,21 @@ require "branch_io_cli/format"
2
2
 
3
3
  module Fastlane
4
4
  module Branch
5
+ module FastlaneFormat
6
+ include BranchIOCLI::Format
7
+ def option(opt)
8
+ if opt =~ /^no_/
9
+ opt_text = "#{opt.to_s.sub(/^no_/, '')}: false"
10
+ else
11
+ opt_text = opt.to_s
12
+ end
13
+ highlight opt_text
14
+ end
15
+ end
16
+
5
17
  module FastlaneMarkdownFormat
6
18
  include BranchIOCLI::Format::MarkdownFormat
19
+ include FastlaneFormat
7
20
 
8
21
  def local_render(template)
9
22
  path = File.expand_path(File.join("..", "..", "..", "..", "..", "assets", "templates", "#{template}.erb"), __FILE__)
@@ -11,20 +24,12 @@ module Fastlane
11
24
  end
12
25
 
13
26
  def table_option(option)
14
- "|#{option.name}|#{option.description}|#{option.env_name}|#{option.type ? 'Boolean' : option.type}|#{option.default_value}|"
15
- end
16
-
17
- def option(opt)
18
- highlight opt.to_s
27
+ "|#{option.name}|#{option.description}|#{option.env_name}|#{option.type.nil? ? 'Boolean' : option.type.name}|#{option.default_value}|"
19
28
  end
20
29
  end
21
30
 
22
31
  module FastlaneDescriptionFormat
23
- include BranchIOCLI::Format
24
-
25
- def option(opt)
26
- highlight opt.to_s
27
- end
32
+ include FastlaneFormat
28
33
 
29
34
  def highlight(text)
30
35
  text
@@ -1,5 +1,5 @@
1
1
  module Fastlane
2
2
  module Branch
3
- VERSION = "0.7.2"
3
+ VERSION = "0.7.3"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fastlane-plugin-branch
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.2
4
+ version: 0.7.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Branch
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2017-11-20 00:00:00.000000000 Z
12
+ date: 2017-11-22 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: branch_io_cli