Merge pull request #450 from iangmaia/cleanup/remove-deliver-file

AliSoftware · web-flow · commit 8f6386991e04 · 2023-02-11T15:52:38.000+01:00
Remove Deliverfile related functionality
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 - Remove the `skip_glotpress` parameter from the `ios_bump_version_release` action [#443]
 - Add the `public_version_xcconfig_file` parameter to the `ios_get_app_version` action to replace the need for an environment variable [#445]
 - Remove the `ios_localize_project` and `ios_update_metadata` actions [#447]
+- Remove the `skip_deliver` parameter from `ios_bump_version_hotfix` and `ios_bump_version_release` actions [#450]
 
 ### New Features
 
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_bump_version_beta.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_bump_version_beta.rb
@@ -15,7 +15,7 @@ def self.run(params)
         Fastlane::Helper::Ios::VersionHelper.update_xc_configs(@new_beta_version, @short_version, @new_internal_version)
         UI.message 'Done!'
 
-        Fastlane::Helper::Ios::GitHelper.commit_version_bump(include_deliverfile: false)
+        Fastlane::Helper::Ios::GitHelper.commit_version_bump()
       end
 
       #####################################################
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_bump_version_hotfix.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_bump_version_hotfix.rb
@@ -9,18 +9,11 @@ def self.run(params)
         create_config(params[:previous_version], params[:version])
         show_config()
 
-        update_deliverfile = params[:skip_deliver] == false
-        if update_deliverfile
-          UI.message 'Updating Fastlane deliver file...'
-          Fastlane::Helper::Ios::VersionHelper.update_fastlane_deliver(@new_short_version)
-          UI.message 'Done!'
-        end
-
         UI.message 'Updating XcConfig...'
         Fastlane::Helper::Ios::VersionHelper.update_xc_configs(@new_version, @new_short_version, @new_version_internal)
         UI.message 'Done!'
 
-        Fastlane::Helper::Ios::GitHelper.commit_version_bump(include_deliverfile: update_deliverfile)
+        Fastlane::Helper::Ios::GitHelper.commit_version_bump()
 
         UI.message 'Done.'
       end
@@ -51,16 +44,6 @@ def self.available_options
             description: 'The version to branch from',
             is_string: true
           ),
-          FastlaneCore::ConfigItem.new(
-            key: :skip_deliver,
-            env_name: 'FL_IOS_BUMP_VERSION_HOTFIX_SKIP_DELIVER',
-            description: 'Skips Deliverfile key update',
-            is_string: false, # Boolean parameter
-            optional: true,
-            # Don't skip the Deliverfile by default. At the time of writing, 2 out of 3 consumers
-            # still have a Deliverfile.
-            default_value: false
-          ),
         ]
       end
 
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_bump_version_release.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_bump_version_release.rb
@@ -21,17 +21,11 @@ def self.run(params)
         Fastlane::Helper::GitHelper.create_branch(@new_release_branch, from: default_branch)
         UI.message 'Done!'
 
-        UI.message 'Updating Fastlane deliver file...' unless params[:skip_deliver]
-        Fastlane::Helper::Ios::VersionHelper.update_fastlane_deliver(@new_short_version) unless params[:skip_deliver]
-        UI.message 'Done!' unless params[:skip_deliver]
-
         UI.message 'Updating XcConfig...'
         Fastlane::Helper::Ios::VersionHelper.update_xc_configs(@new_version, @new_short_version, @new_version_internal)
         UI.message 'Done!'
 
-        Fastlane::Helper::Ios::GitHelper.commit_version_bump(
-          include_deliverfile: !params[:skip_deliver]
-        )
+        Fastlane::Helper::Ios::GitHelper.commit_version_bump()
 
         UI.message 'Done.'
       end
@@ -50,11 +44,6 @@ def self.details
 
       def self.available_options
         [
-          FastlaneCore::ConfigItem.new(key: :skip_deliver,
-                                       env_name: 'FL_IOS_CODEFREEZE_BUMP_SKIPDELIVER',
-                                       description: 'Skips Deliver key update',
-                                       type: Boolean,
-                                       default_value: false),
           FastlaneCore::ConfigItem.new(key: :default_branch,
                                        env_name: 'FL_RELEASE_TOOLKIT_DEFAULT_BRANCH',
                                        description: 'Default branch of the repository',
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_git_helper.rb b/lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_git_helper.rb
@@ -8,15 +8,11 @@ module GitHelper
         #
         # This typically commits and pushes:
         #  - The files in `./config/*` – especially `Version.*.xcconfig` files
-        #  - The `fastlane/Deliverfile` file (which contains the `app_version` line)
         #
         # @env PROJECT_ROOT_FOLDER The path to the git root of the project
         #
-        # @param [Bool] include_deliverfile If true (the default), includes the `fastlane/Deliverfile` in files being commited
-        #
-        def self.commit_version_bump(include_deliverfile: true)
+        def self.commit_version_bump
           files_list = [File.join(get_from_env!(key: 'PROJECT_ROOT_FOLDER'), 'config', '.')]
-          files_list.append File.join('fastlane', 'Deliverfile') if include_deliverfile
 
           Fastlane::Helper::GitHelper.commit(message: 'Bump version number', files: files_list, push: true)
         end
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb b/lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb
@@ -215,20 +215,6 @@ def self.bump_version_release
           return verified_version
         end
 
-        # Updates the `app_version` entry in the `Deliverfile`
-        #
-        # @param [String] new_version The new value to set the `app_version` entry to.
-        # @raise [UserError] If the Deliverfile was not found.
-        #
-        def self.update_fastlane_deliver(new_version)
-          fd_file = './fastlane/Deliverfile'
-          if File.exist?(fd_file)
-            Action.sh("sed -i '' \"s/app_version.*/app_version \\\"#{new_version}\\\"/\" #{fd_file}")
-          else
-            UI.user_error!("Can't find #{fd_file}.")
-          end
-        end
-
         # Update the `.xcconfig` files (the public one, and the internal one if it exists) with the new version strings.
         #
         # @env PUBLIC_CONFIG_FILE The path to the xcconfig file containing the public version numbers.
diff --git a/spec/ios_bump_version_release_spec.rb b/spec/ios_bump_version_release_spec.rb
@@ -11,34 +11,17 @@
       other_action_mock = double()
       allow(Fastlane::Action).to receive(:other_action).and_return(other_action_mock)
       allow(other_action_mock).to receive(:ensure_git_branch).with(branch: default_branch)
-
-      allow(Fastlane::Helper::GitHelper).to receive(:checkout_and_pull).with(default_branch)
-      allow(Fastlane::Helper::GitHelper).to receive(:create_branch).with("release/#{next_version_short}", from: default_branch)
-
       allow(Fastlane::Helper::Ios::VersionHelper).to receive(:read_from_config_file).and_return(version)
-      allow(Fastlane::Helper::Ios::VersionHelper).to receive(:update_xc_configs).with(next_version, next_version_short, nil)
-    end
-
-    it 'does the fastlane deliver update' do
-      skip_deliver = false
-
-      expect(Fastlane::Helper::Ios::VersionHelper).to receive(:update_fastlane_deliver).with(next_version_short)
-      expect(Fastlane::Helper::Ios::GitHelper).to receive(:commit_version_bump).with(include_deliverfile: !skip_deliver)
-
-      run_described_fastlane_action(
-        skip_deliver: skip_deliver,
-        default_branch: default_branch
-      )
     end
 
-    it 'skips the fastlane deliver update properly' do
-      skip_deliver = true
+    it 'correctly uses the next version, short and long' do
+      expect(Fastlane::Helper::GitHelper).to receive(:checkout_and_pull).with(default_branch)
+      expect(Fastlane::Helper::GitHelper).to receive(:create_branch).with("release/#{next_version_short}", from: default_branch)
 
-      expect(Fastlane::Helper::Ios::VersionHelper).not_to receive(:update_fastlane_deliver)
-      expect(Fastlane::Helper::Ios::GitHelper).to receive(:commit_version_bump).with(include_deliverfile: !skip_deliver)
+      expect(Fastlane::Helper::Ios::VersionHelper).to receive(:update_xc_configs).with(next_version, next_version_short, nil)
+      expect(Fastlane::Helper::Ios::GitHelper).to receive(:commit_version_bump)
 
       run_described_fastlane_action(
-        skip_deliver: skip_deliver,
         default_branch: default_branch
       )
     end

Original file line number	Diff line number	Diff line change
`@@ -8,15 +8,11 @@ module GitHelper`
`8`	`8`	`#`
`9`	`9`	`# This typically commits and pushes:`
`10`	`10`	# - The files in `./config/` – especially `Version..xcconfig` files
`11`		- # - The `fastlane/Deliverfile` file (which contains the `app_version` line)
`12`	`11`	`#`
`13`	`12`	`# @env PROJECT_ROOT_FOLDER The path to the git root of the project`
`14`	`13`	`#`
`15`		- # @param [Bool] include_deliverfile If true (the default), includes the `fastlane/Deliverfile` in files being commited
`16`		`- #`
`17`		`- def self.commit_version_bump(include_deliverfile: true)`
	`14`	`+ def self.commit_version_bump`
`18`	`15`	`files_list = [File.join(get_from_env!(key: 'PROJECT_ROOT_FOLDER'), 'config', '.')]`
`19`		`- files_list.append File.join('fastlane', 'Deliverfile') if include_deliverfile`
`20`	`16`
`21`	`17`	`Fastlane::Helper::GitHelper.commit(message: 'Bump version number', files: files_list, push: true)`
`22`	`18`	`end`