Class: Fastlane::Actions::LatestTestflightBuildNumberAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/latest_testflight_build_number.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, deprecated_notes, lane_context, method_missing, other_action, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authors ⇒ Object 



130
131
132
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 130

def self.authors
  ["daveanderson"]
end

.available_options ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 35

def self.available_options
  user = CredentialsManager::AppfileConfig.try_fetch_value(:itunes_connect_id)
  user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)

  [
    FastlaneCore::ConfigItem.new(key: :api_key_path,
                                 env_names: ["APPSTORE_BUILD_NUMBER_API_KEY_PATH", "APP_STORE_CONNECT_API_KEY_PATH"],
                                 description: "Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)",
                                 optional: true,
                                 conflicting_options: [:api_key],
                                 verify_block: proc do |value|
                                   UI.user_error!("Couldn't find API key JSON file at path '#{value}'") unless File.exist?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :api_key,
                                 env_names: ["APPSTORE_BUILD_NUMBER_API_KEY", "APP_STORE_CONNECT_API_KEY"],
                                 description: "Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option)",
                                 type: Hash,
                                 optional: true,
                                 sensitive: true,
                                 conflicting_options: [:api_key_path]),
    FastlaneCore::ConfigItem.new(key: :live,
                                 short_option: "-l",
                                 env_name: "CURRENT_BUILD_NUMBER_LIVE",
                                 description: "Query the live version (ready-for-sale)",
                                 optional: true,
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :app_identifier,
                                 short_option: "-a",
                                 env_name: "FASTLANE_APP_IDENTIFIER",
                                 description: "The bundle identifier of your app",
                                 code_gen_sensitive: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier),
                                 default_value_dynamic: true),
    FastlaneCore::ConfigItem.new(key: :username,
                                 short_option: "-u",
                                 env_name: "ITUNESCONNECT_USER",
                                 description: "Your Apple ID Username",
                                 optional: true,
                                 default_value: user,
                                 default_value_dynamic: true),
    FastlaneCore::ConfigItem.new(key: :version,
                                 env_name: "LATEST_VERSION",
                                 description: "The version number whose latest build number we want",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :platform,
                                 short_option: "-j",
                                 env_name: "APPSTORE_PLATFORM",
                                 description: "The platform to use (optional)",
                                 optional: true,
                                 is_string: true,
                                 default_value: "ios",
                                 verify_block: proc do |value|
                                   UI.user_error!("The platform can only be ios, osx, or appletvos") unless %('osx', ios', 'appletvos').include?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :initial_build_number,
                                 env_name: "INITIAL_BUILD_NUMBER",
                                 description: "sets the build number to given value if no build is in current train",
                                 default_value: 1,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :team_id,
                                 short_option: "-k",
                                 env_name: "LATEST_TESTFLIGHT_BUILD_NUMBER_TEAM_ID",
                                 description: "The ID of your App Store Connect team if you're in multiple teams",
                                 optional: true,
                                 is_string: false, # as we also allow integers, which we convert to strings anyway
                                 code_gen_sensitive: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
                                 default_value_dynamic: true),
    FastlaneCore::ConfigItem.new(key: :team_name,
                                 short_option: "-e",
                                 env_name: "LATEST_TESTFLIGHT_BUILD_NUMBER_TEAM_NAME",
                                 description: "The name of your App Store Connect team if you're in multiple teams",
                                 optional: true,
                                 code_gen_sensitive: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
                                 default_value_dynamic: true)
  ]
end

.category ⇒ Object 



151
152
153
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 151

def self.category
  :app_store_connect
end

.description ⇒ Object 



24
25
26
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 24

def self.description
  "Fetches most recent build number from TestFlight"
end

.details ⇒ Object 



28
29
30
31
32
33
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 28

def self.details
  [
    "Provides a way to have `increment_build_number` be based on the latest build you uploaded to iTC.",
    "Fetches the most recent build number from TestFlight based on the version number. Provides a way to have `increment_build_number` be based on the latest build you uploaded to iTC."
  ].join("\n")
end

.example_code ⇒ Object 



138
139
140
141
142
143
144
145
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 138

def self.example_code
  [
    'latest_testflight_build_number(version: "1.3")',
    'increment_build_number({
      build_number: latest_testflight_build_number + 1
    })'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



134
135
136
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 134

def self.is_supported?(platform)
  [:ios, :mac].include?(platform)
end

.output ⇒ Object 



115
116
117
118
119
120
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 115

def self.output
  [
    ['LATEST_TESTFLIGHT_BUILD_NUMBER', 'The latest build number of the latest version of the app uploaded to TestFlight'],
    ['LATEST_TESTFLIGHT_VERSION', 'The version of the latest build number']
  ]
end

.return_type ⇒ Object 



126
127
128
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 126

def self.return_type
  :int
end

.return_value ⇒ Object 



122
123
124
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 122

def self.return_value
  "Integer representation of the latest build number uploaded to TestFlight"
end

.run(params) ⇒ Object 



11
12
13
14
15
16
17
18
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 11

def self.run(params)
  AppStoreBuildNumberAction.run(params)
  build_nr = Actions.lane_context[SharedValues::LATEST_BUILD_NUMBER]
  build_v = Actions.lane_context[SharedValues::LATEST_VERSION]
  Actions.lane_context[SharedValues::LATEST_TESTFLIGHT_BUILD_NUMBER] = build_nr
  Actions.lane_context[SharedValues::LATEST_TESTFLIGHT_VERSION] = build_v
  return build_nr
end

.sample_return_value ⇒ Object 



147
148
149
 
# File 'fastlane/lib/fastlane/actions/latest_testflight_build_number.rb', line 147

def self.sample_return_value
  2
end