Class: Fastlane::Actions::EnsureXcodeVersionAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/ensure_xcode_version.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, lane_context, method_missing, other_action, return_type, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authors ⇒ Object 



105
106
107
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 105

def self.authors
  ["JaviSoto", "KrauseFx"]
end

.available_options ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 83

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :version,
                                 env_name: "FL_ENSURE_XCODE_VERSION",
                                 description: "Xcode version to verify that is selected",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :strict,
                                 description: "Should the version be verified strictly (all 3 version numbers), or matching only the given version numbers (i.e. `11.3` == `11.3.x`)",
                                 type: Boolean,
                                 default_value: true)
  ]
end

.category ⇒ Object 



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

def self.category
  :building
end

.deprecated_notes ⇒ Object 



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

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 



70
71
72
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 70

def self.description
  "Ensure the right version of Xcode is used"
end

.details ⇒ Object 



74
75
76
77
78
79
80
81
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 74

def self.details
  [
    "If building your app requires a specific version of Xcode, you can invoke this command before using gym.",
    "For example, to ensure that a beta version of Xcode is not accidentally selected to build, which would make uploading to TestFlight fail.",
    "You can either manually provide a specific version using `version:` or you make use of the `.xcode-version` file.",
    "Using the `strict` parameter, you can either verify the full set of version numbers strictly (i.e. `11.3.1`) or only a subset of them (i.e. `11.3` or `11`)."
  ].join("\n")
end

.error(selected_version, required_version) ⇒ Object 



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

def self.error(selected_version, required_version)
  UI.message("Selected Xcode version is not correct: #{selected_version}. You expected #{required_version}.")
  UI.message("To correct this, use: `xcode_select(version: #{required_version})`.")

  UI.user_error!("Selected Xcode version doesn't match your requirement.\nExpected: Xcode #{required_version}\nActual: Xcode #{selected_version}\n")
end

.example_code ⇒ Object 



109
110
111
112
113
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 109

def self.example_code
  [
    'ensure_xcode_version(version: "12.5")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



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

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

.output ⇒ Object 



96
97
98
99
100
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 96

def self.output
  [
    ['FL_ENSURE_XCODE_VERSION', 'Xcode version to verify that is selected']
  ]
end

.return_value ⇒ Object 



102
103
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 102

def self.return_value
end

.run(params) ⇒ 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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 4

def self.run(params)
  Actions.verify_gem!('xcode-install')
  required_version = params[:version]
  strict = params[:strict]

  if required_version.to_s.length == 0
    # The user didn't provide an Xcode version, let's see
    # if the current project has a `.xcode-version` file
    #
    # The code below can be improved to also consider
    # the directory of the Xcode project
    xcode_version_paths = Dir.glob(".xcode-version")

    if xcode_version_paths.first
      UI.verbose("Loading required version from #{xcode_version_paths.first}")
      required_version = File.read(xcode_version_paths.first).strip
    else
      UI.user_error!("No version: provided when calling the `ensure_xcode_version` action")
    end
  end

  selected_version = sh("xcversion selected").match(/^Xcode (.*)$/)[1]

  begin
    selected_version = Gem::Version.new(selected_version)
    required_version = Gem::Version.new(required_version)
  rescue ArgumentError => ex
    UI.user_error!("Invalid version number provided, make sure it's valid: #{ex}")
  end

  if strict == true
    if selected_version == required_version
      success(selected_version)
    else
      error(selected_version, required_version)
    end
  else
    required_version_numbers = required_version.to_s.split(".")
    selected_version_numbers = selected_version.to_s.split(".")

    required_version_numbers.each_with_index do |required_version_number, index|
      selected_version_number = selected_version_numbers[index]
      next unless required_version_number != selected_version_number
      error(selected_version, required_version)
      break
    end

    success(selected_version)
  end
end

.success(selected_version) ⇒ Object 



55
56
57
 
# File 'fastlane/lib/fastlane/actions/ensure_xcode_version.rb', line 55

def self.success(selected_version)
  UI.success("Selected Xcode version is correct: #{selected_version}")
end