Class: Fastlane::Actions::XcversionAction

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

Constant Summary

Constants inherited from Fastlane::Action

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

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, 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 



29
30
31
 
# File 'fastlane/lib/fastlane/actions/xcversion.rb', line 29

def self.authors
  ["oysta", "rogerluan"]
end

.available_options ⇒ Object 



33
34
35
36
37
38
39
40
41
42
 
# File 'fastlane/lib/fastlane/actions/xcversion.rb', line 33

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :version,
                                 env_name: "FL_XCODE_VERSION",
                                 description: "The version of Xcode to select specified as a Gem::Version requirement string (e.g. '~> 7.1.0'). Defaults to the value specified in the .xcode-version file ",
                                 default_value: Helper::XcodesHelper.read_xcode_version_file,
                                 default_value_dynamic: true,
                                 verify_block: Helper::XcodesHelper::Verify.method(:requirement))
  ]
end

.category ⇒ Object 



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

def self.category
  :deprecated
end

.deprecated_notes ⇒ Object 



60
61
62
 
# File 'fastlane/lib/fastlane/actions/xcversion.rb', line 60

def self.deprecated_notes
  "The xcode-install gem, which this action depends on, has been sunset. Please migrate to [xcodes](https://docs.fastlane.tools/actions/xcodes). You can find a migration guide here: [xcpretty/xcode-install/MIGRATION.md](https://github.com/xcpretty/xcode-install/blob/master/MIGRATION.md)"
end

.description ⇒ Object 



18
19
20
 
# File 'fastlane/lib/fastlane/actions/xcversion.rb', line 18

def self.description
  "Select an Xcode to use by version specifier"
end

.details ⇒ Object 



22
23
24
25
26
27
 
# File 'fastlane/lib/fastlane/actions/xcversion.rb', line 22

def self.details
  [
    "Finds and selects a version of an installed Xcode that best matches the provided [`Gem::Version` requirement specifier](http://www.rubydoc.info/github/rubygems/rubygems/Gem/Version)",
    "You can either manually provide a specific version using `version:` or you make use of the `.xcode-version` file."
  ].join("\n")
end

.example_code ⇒ Object 



48
49
50
51
52
53
54
 
# File 'fastlane/lib/fastlane/actions/xcversion.rb', line 48

def self.example_code
  [
    'xcversion(version: "8.1") # Selects Xcode 8.1.0',
    'xcversion(version: "~> 8.1.0") # Selects the latest installed version from the 8.1.x set',
    'xcversion # When missing, the version value defaults to the value specified in the .xcode-version file'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



44
45
46
 
# File 'fastlane/lib/fastlane/actions/xcversion.rb', line 44

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

.run(params) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'fastlane/lib/fastlane/actions/xcversion.rb', line 4

def self.run(params)
  Actions.verify_gem!('xcode-install')

  version = params[:version]

  xcode = Helper::XcversionHelper.find_xcode(version)
  UI.user_error!("Cannot find an installed Xcode satisfying '#{version}'") if xcode.nil?

  UI.verbose("Found Xcode version #{xcode.version} at #{xcode.path} satisfying requirement #{version}")
  UI.message("Setting Xcode version to #{xcode.path} for all build steps")

  ENV["DEVELOPER_DIR"] = File.join(xcode.path, "/Contents/Developer")
end