Class: Fastlane::Actions::UploadToTestflightAction

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

Direct Known Subclasses

PilotAction, TestflightAction

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, output, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authors ⇒ Object 



115
116
117
 
# File 'fastlane/lib/fastlane/actions/upload_to_testflight.rb', line 115

def self.authors
  ["KrauseFx"]
end

.available_options ⇒ Object 



51
52
53
54
55
 
# File 'fastlane/lib/fastlane/actions/upload_to_testflight.rb', line 51

def self.available_options
  require "pilot"
  require "pilot/options"
  FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options)
end

.category ⇒ Object 



111
112
113
 
# File 'fastlane/lib/fastlane/actions/upload_to_testflight.rb', line 111

def self.category
  :beta
end

.description ⇒ Object 



40
41
42
 
# File 'fastlane/lib/fastlane/actions/upload_to_testflight.rb', line 40

def self.description
  "Upload new binary to App Store Connect for TestFlight beta testing (via _pilot_)"
end

.details ⇒ Object 



44
45
46
47
48
49
 
# File 'fastlane/lib/fastlane/actions/upload_to_testflight.rb', line 44

def self.details
  [
    "More details can be found on https://docs.fastlane.tools/actions/pilot/.",
    "This integration will only do the TestFlight upload."
  ].join("\n")
end

.example_code ⇒ Object 



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

def self.example_code
  [
    'upload_to_testflight',
    'testflight # alias for "upload_to_testflight"',
    'pilot # alias for "upload_to_testflight"',
    'upload_to_testflight(skip_submission: true) # to only upload the build',
    'upload_to_testflight(
      username: "[email protected]",
      app_identifier: "com.krausefx.app",
      itc_provider: "abcde12345" # pass a specific value to the iTMSTransporter -itc_provider option
    )',
    'upload_to_testflight(
      beta_app_feedback_email: "[email protected]",
      beta_app_description: "This is a description of my app",
      demo_account_required: true,
      notify_external_testers: false,
      changelog: "This is my changelog of things that have changed in a log"
    )',
    'upload_to_testflight(
      beta_app_review_info: {
        contact_email: "[email protected]",
        contact_first_name: "Connect",
        contact_last_name: "API",
        contact_phone: "5558675309",
        demo_account_name: "[email protected]",
        demo_account_password: "connectapi",
        notes: "this is review note for the reviewer <3 thank you for reviewing"
      },
      localized_app_info: {
        "default": {
          feedback_email: "[email protected]",
          marketing_url: "https://example.com/marketing-defafult",
          privacy_policy_url: "https://example.com/privacy-defafult",
          description: "Default description",
        },
        "en-GB": {
          feedback_email: "[email protected]",
          marketing_url: "https://example.com/marketing-en-gb",
          privacy_policy_url: "https://example.com/privacy-en-gb",
          description: "en-gb description",
        }
      },
      localized_build_info: {
        "default": {
          whats_new: "Default changelog",
        },
        "en-GB": {
          whats_new: "en-gb changelog",
        }
      }
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



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

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

.run(values) ⇒ Object 



4
5
6
7
8
9
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
 
# File 'fastlane/lib/fastlane/actions/upload_to_testflight.rb', line 4

def self.run(values)
  require 'pilot'
  require 'pilot/options'

  distribute_only = values[:distribute_only]

  changelog = Actions.lane_context[SharedValues::FL_CHANGELOG]
  values[:changelog] ||= changelog if changelog

  unless distribute_only
    values[:ipa] ||= Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
    values[:ipa] = File.expand_path(values[:ipa]) if values[:ipa]
  end

  # Only set :api_key from SharedValues if :api_key_path isn't set (conflicting options)
  unless values[:api_key_path]
    values[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
  end

  return values if Helper.test?

  if distribute_only
    build_manager = Pilot::BuildManager.new
    build_manager.start(values, should_login: true)

    build_manager.wait_for_build_processing_to_be_complete(false) unless values[:skip_waiting_for_build_processing]
    build_manager.distribute(values) # we already have the finished config
  else
    Pilot::BuildManager.new.upload(values) # we already have the finished config
  end
end