Class: Fastlane::Actions::CommitVersionBumpAction

Inherits:
Fastlane::Action show all
Defined in:
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

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, lane_context, method_missing, other_action, output, return_value, sample_return_value, sh, step_text

Class Method Details

.author ⇒ Object 



174
175
176
 
# File 'lib/fastlane/actions/commit_version_bump.rb', line 174

def self.author
  "lmirosevic"
end

.available_options ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/fastlane/actions/commit_version_bump.rb', line 124

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)
  ]
end

.category ⇒ Object 



192
193
194
 
# File 'lib/fastlane/actions/commit_version_bump.rb', line 192

def self.category
  :source_control
end

.description ⇒ Object 



120
121
122
 
# File 'lib/fastlane/actions/commit_version_bump.rb', line 120

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

.details ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/fastlane/actions/commit_version_bump.rb', line 158

def self.details
  [
    "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:",
    "- All .plist files",
    "- The `.xcodeproj/project.pbxproj` file",
    "",
    "Then commits those files to the repo.",
    "",
    "Customise the message with the `:message` option, 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` action to clean those temporary files up before running this action."
  ].join("\n")
end

.example_code ⇒ Object 



182
183
184
185
186
187
188
189
190
 
# File 'lib/fastlane/actions/commit_version_bump.rb', line 182

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
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/fastlane/actions/commit_version_bump.rb', line 178

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

.run(params) ⇒ Object 



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
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
 
# File 'lib/fastlane/actions/commit_version_bump.rb', line 5

def self.run(params)
  require 'xcodeproj'
  require 'pathname'
  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 the Cocoapods one)
    xcodeproj_paths = Dir[File.expand_path(File.join(repo_path, '**/*.xcodeproj'))].reject { |path| %r{Pods\/.*.xcodeproj} =~ 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
  # rubocop:disable Style/MultilineBlockChain
  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
  # rubocop:enable Style/MultilineBlockChain

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

  # 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 = []
  expected_changed_files << pbxproj_path
  expected_changed_files << info_plist_files
  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 uncommited 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

  if params[:settings]
    expected_changed_files << 'Settings.bundle/Root.plist'
  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
    build_number = Actions.lane_context[Actions::SharedValues::BUILD_NUMBER]

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

    Actions.sh("git commit -m '#{params[:message]}'")

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