Updates ios_update_release_notes to accepts an argument with the changelog file path

Author: leandroalonso

lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_update_release_notes.rb

@@ -8,7 +8,7 @@ def self.run(params)
         require_relative '../../helper/release_notes_helper'
         require_relative '../../helper/git_helper'
 
-        path = File.join(ENV['PROJECT_ROOT_FOLDER'] || '.', 'RELEASE-NOTES.txt')
+        path = params[:release_notes_file_path]
         next_version = Fastlane::Helper::Ios::VersionHelper.calc_next_release_version(params[:new_version])
 
         Fastlane::Helper::ReleaseNotesHelper.add_new_section(path: path, section_title: next_version)
@@ -35,6 +35,11 @@ def self.available_options
                                        env_name: 'FL_IOS_UPDATE_RELEASE_NOTES_VERSION',
                                        description: 'The version we are currently freezing; An empty entry for the _next_ version after this one will be added to the release notes',
                                        is_string: true),
+          FastlaneCore::ConfigItem.new(key: :release_notes_file_path,
+                                       env_name: 'FL_IOS_UPDATE_RELEASE_NOTES_FILE_PATH',
+                                       description: 'The path to the release notes file to be updated',
+                                       is_string: true,
+                                       default_value: File.join(ENV['PROJECT_ROOT_FOLDER'] || '.', 'RELEASE-NOTES.txt')),
         ]
       end
 

spec/ios_update_release_notes_spec.rb

@@ -2,15 +2,15 @@
 
 describe Fastlane::Actions::IosUpdateReleaseNotesAction do
   let(:release_notes_txt) { File.join(File.dirname(__FILE__), 'RELEASE-NOTES.txt') }
+  let(:changelog_md) { File.join(File.dirname(__FILE__), 'CHANGELOG.md') }
 
   after do
-    FileUtils.remove_entry release_notes_txt
+    FileUtils.rm([release_notes_txt, changelog_md], force: true)
   end
 
   describe '#ios_update_release_notes' do
     it 'adds a new section on RELEASE-NOTES.txt' do
       # Arrange
-
       ENV['PROJECT_ROOT_FOLDER'] = File.dirname(__FILE__)
       File.write(release_notes_txt, '')
 
@@ -22,5 +22,20 @@
       # Assert
       expect(File.read(release_notes_txt)).to eq("1.1\n-----\n\n\n")
     end
+
+    it 'adds a new section on the given file' do
+      # Arrange
+      ENV['PROJECT_ROOT_FOLDER'] = File.dirname(__FILE__)
+      File.write(changelog_md, '')
+
+      # Act
+      run_described_fastlane_action(
+        new_version: '1.0',
+        release_notes_file_path: changelog_md
+      )
+
+      # Assert
+      expect(File.read(changelog_md)).to eq("1.1\n-----\n\n\n")
+    end
   end
 end