Class: Fastlane::Actions::CommitVersionBumpAction

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

Overview

Commits the current changes in the repo as a version bump, checking to make sure only files which contain version information have been changed.

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, authors, deprecated_notes, lane_context, method_missing, other_action, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authorObject


210
211
212
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 210

def self.author
  "lmirosevic"
end

.available_optionsObject


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 150

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :message,
                                 env_name: "FL_COMMIT_BUMP_MESSAGE",
                                 description: "The commit message when committing the version bump",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :xcodeproj,
                                 env_name: "FL_BUILD_NUMBER_PROJECT",
                                 description: "The path to your project file (Not the workspace). If you have only one, this is optional",
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with?(".xcworkspace")
                                   UI.user_error!("Could not find Xcode project") unless File.exist?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :force,
                                 env_name: "FL_FORCE_COMMIT",
                                 description: "Forces the commit, even if other files than the ones containing the version number have been modified",
                                 optional: true,
                                 default_value: false,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :settings,
                                 env_name: "FL_COMMIT_INCLUDE_SETTINGS",
                                 description: "Include Settings.bundle/Root.plist with version bump",
                                 optional: true,
                                 default_value: false,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :ignore,
                                 description: "A regular expression used to filter matched plist files to be modified",
                                 optional: true,
                                 default_value: nil,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :include,
                                 description: "A list of extra files to be included in the version bump (string array or comma-separated string)",
                                 optional: true,
                                 default_value: [],
                                 type: Array),
    FastlaneCore::ConfigItem.new(key: :no_verify,
                                env_name: "FL_GIT_PUSH_USE_NO_VERIFY",
                                description: "Whether or not to use --no-verify",
                                type: Boolean,
                                default_value: false)
  ]
end

.build_git_command(params) ⇒ Object


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 282

def build_git_command(params)
  build_number = Actions.lane_context[Actions::SharedValues::BUILD_NUMBER]

  params[:message] ||= (build_number ? "Version Bump to #{build_number}" : "Version Bump")

  command = [
    'git',
    'commit',
    '-m',
    "'#{params[:message]}'"
  ]

  command << '--no-verify' if params[:no_verify]

  return command.join(' ')
end

.categoryObject


246
247
248
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 246

def self.category
  :source_control
end

.descriptionObject


140
141
142
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 140

def self.description
  "Creates a 'Version Bump' commit. Run after `increment_build_number`"
end

.detailsObject


194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 194

def self.details
  list = <<-LIST.markdown_list
    All `.plist` files
    The `.xcodeproj/project.pbxproj` file
  LIST

  [
    "This action will create a 'Version Bump' commit in your repo. Useful in conjunction with `increment_build_number`.",
    "It checks the repo to make sure that only the relevant files have changed. These are the files that `increment_build_number` (`agvtool`) touches:".markdown_preserve_newlines,
    list,
    "Then commits those files to the repo.",
    "Customize the message with the `:message` option. It defaults to 'Version Bump'.",
    "If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the _ipa_ and or _sigh_ actions, then you can use the [clean_build_artifacts](https://docs.fastlane.tools/actions/clean_build_artifacts/) action to clean those temporary files up before running this action."
  ].join("\n")
end

.example_codeObject


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 218

def self.example_code
  [
    'commit_version_bump',
    'commit_version_bump(
      message: "Version Bump",                    # create a commit with a custom message
      xcodeproj: "./path/to/MyProject.xcodeproj", # optional, if you have multiple Xcode project files, you must specify your main project here
    )',
    'commit_version_bump(
      settings: true # Include Settings.bundle/Root.plist
    )',
    'commit_version_bump(
      settings: "About.plist" # Include Settings.bundle/About.plist
    )',
    'commit_version_bump(
      settings: %w[About.plist Root.plist] # Include more than one plist from Settings.bundle
    )',
    'commit_version_bump(
      include: %w[package.json custom.cfg] # include other updated files as part of the version bump
    )',
    'commit_version_bump(
      ignore: /OtherProject/ # ignore files matching a regular expression
    )',
    'commit_version_bump(
      no_verify: true           # optional, default: false
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


214
215
216
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 214

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

.modified_files_relative_to_repo_root(repo_root) ⇒ Object


271
272
273
274
275
276
277
278
279
280
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 271

def modified_files_relative_to_repo_root(repo_root)
  return [] if Actions.lane_context[SharedValues::MODIFIED_FILES].nil?

  root_pathname = Pathname.new(repo_root)
  all_modified_files = Actions.lane_context[SharedValues::MODIFIED_FILES].map do |path|
    next path unless path =~ %r{^/}
    Pathname.new(path).relative_path_from(root_pathname).to_s
  end
  return all_modified_files.uniq
end

.outputObject


144
145
146
147
148
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 144

def self.output
  [
    ['MODIFIED_FILES', 'The list of paths of modified files']
  ]
end

.run(params) ⇒ Object


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
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 23

def self.run(params)
  require 'xcodeproj'
  require 'set'
  require 'shellwords'

  xcodeproj_path = params[:xcodeproj] ? File.expand_path(File.join('.', params[:xcodeproj])) : nil

  # find the repo root path
  repo_path = Actions.sh('git rev-parse --show-toplevel').strip
  repo_pathname = Pathname.new(repo_path)

  if xcodeproj_path
    # ensure that the xcodeproj passed in was OK
    UI.user_error!("Could not find the specified xcodeproj: #{xcodeproj_path}") unless File.directory?(xcodeproj_path)
  else
    # find an xcodeproj (ignoring dependencies)
    xcodeproj_paths = Fastlane::Helper::XcodeprojHelper.find(repo_path)

    # no projects found: error
    UI.user_error!('Could not find a .xcodeproj in the current repository\'s working directory.') if xcodeproj_paths.count == 0

    # too many projects found: error
    if xcodeproj_paths.count > 1
      relative_projects = xcodeproj_paths.map { |e| Pathname.new(e).relative_path_from(repo_pathname).to_s }.join("\n")
      UI.user_error!("Found multiple .xcodeproj projects in the current repository's working directory. Please specify your app's main project: \n#{relative_projects}")
    end

    # one project found: great
    xcodeproj_path = xcodeproj_paths.first
  end

  # find the pbxproj path, relative to git directory
  pbxproj_pathname = Pathname.new(File.join(xcodeproj_path, 'project.pbxproj'))
  pbxproj_path = pbxproj_pathname.relative_path_from(repo_pathname).to_s

  # find the info_plist files
  project = Xcodeproj::Project.open(xcodeproj_path)
  info_plist_files = project.objects.select do |object|
    object.isa == 'XCBuildConfiguration'
  end.map(&:to_hash).map do |object_hash|
    object_hash['buildSettings']
  end.select do |build_settings|
    build_settings.key?('INFOPLIST_FILE')
  end.map do |build_settings|
    build_settings['INFOPLIST_FILE']
  end.uniq.map do |info_plist_path|
    Pathname.new(File.expand_path(File.join(xcodeproj_path, '..', info_plist_path))).relative_path_from(repo_pathname).to_s
  end

  # Removes .plist files that matched the given expression in the 'ignore' parameter
  ignore_expression = params[:ignore]
  if ignore_expression
    info_plist_files.reject! do |info_plist_file|
      info_plist_file.match(ignore_expression)
    end
  end

  extra_files = params[:include]
  extra_files += modified_files_relative_to_repo_root(repo_path)

  # create our list of files that we expect to have changed, they should all be relative to the project root, which should be equal to the git workdir root
  expected_changed_files = extra_files
  expected_changed_files << pbxproj_path
  expected_changed_files << info_plist_files

  if params[:settings]
    settings_plists_from_param(params[:settings]).each do |file|
      settings_file_pathname = Pathname.new(settings_bundle_file_path(project, file))
      expected_changed_files << settings_file_pathname.relative_path_from(repo_pathname).to_s
    end
  end

  expected_changed_files.flatten!.uniq!

  # get the list of files that have actually changed in our git workdir
  git_dirty_files = Actions.sh('git diff --name-only HEAD').split("\n") + Actions.sh('git ls-files --other --exclude-standard').split("\n")

  # little user hint
  UI.user_error!("No file changes picked up. Make sure you run the `increment_build_number` action first.") if git_dirty_files.empty?

  # check if the files changed are the ones we expected to change (these should be only the files that have version info in them)
  changed_files_as_expected = Set.new(git_dirty_files.map(&:downcase)).subset?(Set.new(expected_changed_files.map(&:downcase)))
  unless changed_files_as_expected
    unless params[:force]
      error = [
        "Found unexpected uncommitted changes in the working directory. Expected these files to have ",
        "changed: \n#{expected_changed_files.join("\n")}.\nBut found these actual changes: ",
        "#{git_dirty_files.join("\n")}.\nMake sure you have cleaned up the build artifacts and ",
        "are only left with the changed version files at this stage in your lane, and don't touch the ",
        "working directory while your lane is running. You can also use the :force option to bypass this ",
        "check, and always commit a version bump regardless of the state of the working directory."
      ].join("\n")
      UI.user_error!(error)
    end
  end

  # get the absolute paths to the files
  git_add_paths = expected_changed_files.map do |path|
    updated = path.gsub("$(SRCROOT)", ".").gsub("${SRCROOT}", ".")
    File.expand_path(File.join(repo_pathname, updated))
  end

  # then create a commit with a message
  Actions.sh("git add #{git_add_paths.map(&:shellescape).join(' ')}")

  begin
    command = build_git_command(params)

    Actions.sh(command)

    UI.success("Committed \"#{params[:message]}\" 💾.")
  rescue => ex
    UI.error(ex)
    UI.important("Didn't commit any changes.")
  end
end

.settings_bundle_file_path(project, settings_file_name) ⇒ Object


264
265
266
267
268
269
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 264

def settings_bundle_file_path(project, settings_file_name)
  settings_bundle = project.files.find { |f| f.path =~ /Settings.bundle/ }
  raise "No Settings.bundle in project" if settings_bundle.nil?

  return File.join(settings_bundle.real_path, settings_file_name)
end

.settings_plists_from_param(param) ⇒ Object


251
252
253
254
255
256
257
258
259
260
261
262
# File 'fastlane/lib/fastlane/actions/commit_version_bump.rb', line 251

def settings_plists_from_param(param)
  if param.kind_of?(String)
    # commit_version_bump settings: "About.plist"
    return [param]
  elsif param.kind_of?(Array)
    # commit_version_bump settings: ["Root.plist", "About.plist"]
    return param
  else
    # commit_version_bump settings: true # Root.plist
    return ["Root.plist"]
  end
end