Class: Fastlane::Actions::UpdateFastlaneAction

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

Overview

Makes sure fastlane tools are up-to-date when running fastlane

Constant Summary collapse

ALL_TOOLS = 
[
  "fastlane",
  "fastlane_core",
  "deliver",
  "snapshot",
  "frameit",
  "pem",
  "sigh",
  "produce",
  "cert",
  "codes",
  "credentials_manager",
  "gym",
  "spaceship",
  "pilot",
  "supply",
  "scan",
  "screengrab",
  "match"
]

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, details, output, return_value, sh, step_text

Class Method Details

.all_installed_tools ⇒ Object 



99
100
101
 
# File 'lib/fastlane/actions/update_fastlane.rb', line 99

def self.all_installed_tools
  Gem::Specification.select { |s| ALL_TOOLS.include? s.name }.map(&:name).uniq
end

.author ⇒ Object 



121
122
123
 
# File 'lib/fastlane/actions/update_fastlane.rb', line 121

def self.author
  "milch"
end

.available_options ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/fastlane/actions/update_fastlane.rb', line 107

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :tools,
                                 env_name: "FL_TOOLS_TO_UPDATE",
                                 description: "Comma separated list of fastlane tools to update (e.g. fastlane,deliver,sigh). If not specified, all currently installed fastlane-tools will be updated",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :no_update,
                                 env_name: "FL_NO_UPDATE",
                                 description: "Don't update during this run. Defaults to false",
                                 is_string: false,
                                 default_value: false)
  ]
end

.description ⇒ Object 



103
104
105
 
# File 'lib/fastlane/actions/update_fastlane.rb', line 103

def self.description
  "Makes sure fastlane-tools are up-to-date when running fastlane"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/fastlane/actions/update_fastlane.rb', line 125

def self.is_supported?(platform)
  true
end

.run(options) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
 
# File 'lib/fastlane/actions/update_fastlane.rb', line 31

def self.run(options)
  if options[:no_update]
    return
  end

  tools_to_update = options[:tools].split ',' unless options[:tools].nil?
  tools_to_update ||= all_installed_tools

  if tools_to_update.count == 0
    Helper.log.error "No tools specified or couldn't find any installed fastlane.tools".red
    return
  end

  Helper.log.info "Looking for updates for #{tools_to_update.join(', ')}..."

  updater = Gem::CommandManager.instance[:update]
  cleaner = Gem::CommandManager.instance[:cleanup]

  sudo_needed = !File.writable?(Gem.dir)

  if sudo_needed
    Helper.log.warn "It seems that your Gem directory is not writable by your current User."
    Helper.log.warn "Fastlane would need sudo rights to update itself, however, running 'sudo fastlane' is not recommended."
    Helper.log.warn "If you still want to use this action, please read the Actions.md documentation on a guide how to set this up."
    return
  end

  highest_versions = updater.highest_installed_gems.keep_if { |key| tools_to_update.include? key }
  update_needed = updater.which_to_update(highest_versions, tools_to_update)

  if update_needed.count == 0
    Helper.log.info "Nothing to update ✅".green
    return
  end

  # suppress updater output - very noisy
  Gem::DefaultUserInteraction.ui = Gem::SilentUI.new

  update_needed.each do |tool_info|
    tool = tool_info[0]
    local_version = Gem::Version.new(highest_versions[tool].version)
    update_url = FastlaneCore::UpdateChecker.generate_fetch_url(tool)
    latest_version = FastlaneCore::UpdateChecker.fetch_latest(update_url)
    Helper.log.info "Updating #{tool} from #{local_version} to #{latest_version} ... 🚀"

    # Approximate_recommendation will create a string like "~> 0.10" from a version 0.10.0, e.g. one that is valid for versions >= 0.10 and <1.0
    updater.update_gem tool, Gem::Requirement.new(local_version.approximate_recommendation)

    Helper.log.info "Finished updating #{tool}"
  end

  all_updated_tools = updater.installer.installed_gems.select do |updated_tool|
    updated_tool.version > highest_versions[updated_tool.name].version if highest_versions[updated_tool.name]
  end

  if all_updated_tools.empty?
    Helper.log.info "All fastlane tools are up-to-date!"
  else
    Helper.log.info "Cleaning up old versions..."
    cleaner.options[:args] = all_updated_tools.map(&:name)
    cleaner.execute
    Helper.log.info "fastlane.tools successfully updated! I will now restart myself... 😴"

    # Set no_update to true so we don't try to update again
    exec "FL_NO_UPDATE=true #{$PROGRAM_NAME} #{ARGV.join ' '}"
  end
end