Class: Fastlane::Actions::LatestTestflightBuildNumberAction

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

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, lane_context, method_missing, other_action, sh, step_text

Class Method Details

.authors ⇒ Object 



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

def self.authors
  ["daveanderson"]
end

.available_options ⇒ Object 



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
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 67

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: :app_identifier,
                                 short_option: "-a",
                                 env_name: "FASTLANE_APP_IDENTIFIER",
                                 description: "The bundle identifier of your app",
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)),
    FastlaneCore::ConfigItem.new(key: :username,
                                 short_option: "-u",
                                 env_name: "ITUNESCONNECT_USER",
                                 description: "Your Apple ID Username",
                                 default_value: user),
    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: :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 iTunes Connect team if you're in multiple teams",
                                 optional: true,
                                 is_string: false, # as we also allow integers, which we convert to strings anyway
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
                                 verify_block: proc do |value|
                                   ENV["FASTLANE_ITC_TEAM_ID"] = value.to_s
                                 end),
    FastlaneCore::ConfigItem.new(key: :team_name,
                                 short_option: "-e",
                                 env_name: "LATEST_TESTFLIGHT_BUILD_NUMBER_TEAM_NAME",
                                 description: "The name of your iTunes Connect team if you're in multiple teams",
                                 optional: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
                                 verify_block: proc do |value|
                                   ENV["FASTLANE_ITC_TEAM_NAME"] = value.to_s
                                 end)
  ]
end

.category ⇒ Object 



144
145
146
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 144

def self.category
  :misc
end

.description ⇒ Object 



56
57
58
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 56

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

.details ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 60

def self.details
  [
    "Provides a way to have increment_build_number be based on the latest build you uploaded to iTC.",
    "Fetches 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 



131
132
133
134
135
136
137
138
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 131

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:

  • (Boolean) 


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

def self.is_supported?(platform)
  platform == :ios
end

.output ⇒ Object 



113
114
115
116
117
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 113

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

.return_value ⇒ Object 



119
120
121
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 119

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

.run(params) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 10

def self.run(params)
  require 'spaceship'

  credentials = CredentialsManager::AccountManager.new(user: params[:username])
  UI.message("Login to iTunes Connect (#{params[:username]})")
  Spaceship::Tunes.(credentials.user, credentials.password)
  Spaceship::Tunes.select_team
  UI.message("Login successful")

  app = Spaceship::Tunes::Application.find(params[:app_identifier])

  version_number = params[:version]
  unless version_number
    # Automatically fetch the latest version in testflight
    begin
      testflight_version = app.build_trains.keys.last
    rescue
      UI.user_error!("could not find any versions on iTC - and 'version' option is not set") unless params[:version]
      testflight_version = params[:version]
    end
    if testflight_version
      version_number = testflight_version
    else
      UI.message("You have to specify a new version number: ")
      version_number = STDIN.gets.strip
    end
  end

  UI.message("Fetching the latest build number for version #{version_number}")

  begin
    train = app.build_trains[version_number]
    build_number = train.builds.map(&:build_version).map(&:to_i).sort.last
  rescue
    UI.user_error!("could not find a build on iTC - and 'initial_build_number' option is not set") unless params[:initial_build_number]
    build_number = params[:initial_build_number]
  end

  UI.message("Latest upload is build number: #{build_number}")
  Actions.lane_context[SharedValues::LATEST_TESTFLIGHT_BUILD_NUMBER] = build_number
end

.sample_return_value ⇒ Object 



140
141
142
 
# File 'lib/fastlane/actions/latest_testflight_build_number.rb', line 140

def self.sample_return_value
  2
end