class Fastlane::Actions::LatestTestflightBuildNumberAction

Public Class Methods

authors() click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 128
def self.authors
  ["daveanderson"]
end
available_options() click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 34
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/#using-fastlane-api-key-hash-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,
                                 type: Boolean,
                                 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,
                                 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,
                                 skip_type_validation: true), # allow Integer, String
    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,
                                 skip_type_validation: true, # allow Integer, String
                                 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() click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 149
def self.category
  :app_store_connect
end
description() click to toggle source

@!group Documentation

# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 23
def self.description
  "Fetches most recent build number from TestFlight"
end
details() click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 27
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() click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 136
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) click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 132
def self.is_supported?(platform)
  [:ios, :mac].include?(platform)
end
output() click to toggle source
# File fastlane/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'],
    ['LATEST_TESTFLIGHT_VERSION', 'The version of the latest build number']
  ]
end
return_type() click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 124
def self.return_type
  :int
end
return_value() click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 120
def self.return_value
  "Integer representation of the latest build number uploaded to TestFlight"
end
run(params) click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 11
def self.run(params)
  build_v, build_nr = AppStoreBuildNumberAction.get_build_version_and_number(params)

  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() click to toggle source
# File fastlane/lib/fastlane/actions/latest_testflight_build_number.rb, line 145
def self.sample_return_value
  2
end