Class: Fastlane::Actions::UpdateFastlaneAction

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

Overview

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

Constant Summary collapse

ALL_TOOLS =
["fastlane"]

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

.authorsObject


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

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

.available_optionsObject


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'fastlane/lib/fastlane/actions/update_fastlane.rb', line 99

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :no_update,
                                 env_name: "FL_NO_UPDATE",
                                 description: "Don't update during this run. This is used internally",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :nightly,
                                 env_name: "FL_UPDATE_FASTLANE_NIGHTLY",
                                 description: "Opt-in to install and use nightly fastlane builds",
                                 is_string: false,
                                 default_value: false,
                                 deprecated: "Nightly builds are no longer being made available")
  ]
end

.categoryObject


132
133
134
# File 'fastlane/lib/fastlane/actions/update_fastlane.rb', line 132

def self.category
  :misc
end

.descriptionObject


74
75
76
# File 'fastlane/lib/fastlane/actions/update_fastlane.rb', line 74

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

.detailsObject


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'fastlane/lib/fastlane/actions/update_fastlane.rb', line 78

def self.details
  sample = <<-SAMPLE.markdown_sample
    ```bash
    export GEM_HOME=~/.gems
    export PATH=$PATH:~/.gems/bin
    ```
  SAMPLE

  [
    "This action will update fastlane to the most recent version - major version updates will not be performed automatically, as they might include breaking changes. If an update was performed, fastlane will be restarted before the run continues.",
    "",
    "If you are using rbenv or rvm, everything should be good to go. However, if you are using the system's default ruby, some additional setup is needed for this action to work correctly. In short, fastlane needs to be able to access your gem library without running in `sudo` mode.",
    "",
    "The simplest possible fix for this is putting the following lines into your `~/.bashrc` or `~/.zshrc` file:".markdown_preserve_newlines,
    sample,
    "After the above changes, restart your terminal, then run `mkdir $GEM_HOME` to create the new gem directory. After this, you're good to go!",
    "",
    "Recommended usage of the `update_fastlane` action is at the top inside of the `before_all` block, before running any other action."
  ].join("\n")
end

.example_codeObject


123
124
125
126
127
128
129
130
# File 'fastlane/lib/fastlane/actions/update_fastlane.rb', line 123

def self.example_code
  [
    'before_all do
      update_fastlane
      # ...
    end'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


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

def self.is_supported?(platform)
  true
end

.run(options) ⇒ Object


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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'fastlane/lib/fastlane/actions/update_fastlane.rb', line 10

def self.run(options)
  return if options[:no_update] # this is used to update itself

  tools_to_update = ALL_TOOLS
  UI.message("Looking for updates for #{tools_to_update.join(', ')}...")

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

  gem_dir = ENV['GEM_HOME'] || Gem.dir
  sudo_needed = !File.writable?(gem_dir)

  if sudo_needed
    UI.important("It seems that your Gem directory is not writable by your current user.")
    UI.important("fastlane would need sudo rights to update itself, however, running 'sudo fastlane' is not recommended.")
    UI.important("If you still want to use this action, please read the documentation on how to set this up:")
    UI.important("https://docs.fastlane.tools/actions/update_fastlane/")
    return
  end

  unless updater.respond_to?(:highest_installed_gems)
    UI.important("The update_fastlane action requires rubygems version 2.1.0 or greater.")
    UI.important("Please update your version of ruby gems before proceeding.")
    UI.command "gem install rubygems-update"
    UI.command "update_rubygems"
    UI.command "gem update --system"
    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
    UI.success("Nothing to update ✅")
    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)
    latest_official_version = FastlaneCore::UpdateChecker.fetch_latest(tool)

    UI.message("Updating #{tool} from #{local_version.to_s.yellow} to #{latest_official_version.to_s.yellow}... 🚀")

    # 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
    requirement_version = local_version.approximate_recommendation
    updater.update_gem(tool, Gem::Requirement.new(requirement_version))

    UI.success("Finished updating #{tool}")
  end

  UI.message("Cleaning up old versions...")
  cleaner.options[:args] = tools_to_update
  cleaner.execute

  UI.message("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