Merge pull request #396 from wordpress-mobile/add/argument-to-update-release-notes

Add optional `release_notes_file_path` arg to `update_release_notes`

Author: leandroalonso

CHANGELOG.md

@@ -26,6 +26,7 @@ _None_
 
 - Add `tools:ignore="InconsistentArrays"` to `available_languages.xml` to avoid a linter warning on repos hosting multiple app flavors. [#390]
 - Add the ability to provide a custom message for builds triggered via `buildkite_trigger_build` action [#392]
+- Add optional `release_notes_file_path` to `ios_update_release_notes` and `android_update_release_notes` [#396]
 
 ### Bug Fixes
 

lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_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::Android::VersionHelper.calc_next_release_short_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_ANDROID_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_ANDROID_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
 

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/android_update_release_notes_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Fastlane::Actions::AndroidUpdateReleaseNotesAction do
+  let(:new_section) do
+    <<~CONTENT
+      1.1
+      -----
+
+
+    CONTENT
+  end
+
+  let(:content) do
+    <<~CONTENT
+      1.0
+      -----
+      - Item 1 for v1.0
+      - Item 2 for v1.0
+
+      // Comment in the middle
+
+      0.9.0
+      -----
+      - Item 1 for v0.9.0
+      - Item 2 for v0.9.0
+    CONTENT
+  end
+
+  describe '#android_update_release_notes' do
+    it 'adds a new section on RELEASE-NOTES.txt' do
+      in_tmp_dir do |tmp_dir|
+        # Arrange
+        release_notes_txt = File.join(tmp_dir, 'RELEASE-NOTES.txt')
+        File.write(release_notes_txt, content)
+
+        # Act
+        run_described_fastlane_action(
+          new_version: '1.0'
+        )
+
+        # Assert
+        expect(File.read(release_notes_txt)).to eq(new_section + content)
+      end
+    end
+
+    it 'adds a new section on the given file' do
+      in_tmp_dir do |tmp_dir|
+        # Arrange
+        changelog_md = File.join(tmp_dir, 'CHANGELOG.md')
+        File.write(changelog_md, content)
+
+        # Act
+        run_described_fastlane_action(
+          new_version: '1.0',
+          release_notes_file_path: changelog_md
+        )
+
+        # Assert
+        expect(File.read(changelog_md)).to eq(new_section + content)
+      end
+    end
+  end
+end

spec/ios_update_release_notes_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Fastlane::Actions::IosUpdateReleaseNotesAction do
+  let(:new_section) do
+    <<~CONTENT
+      1.1
+      -----
+
+
+    CONTENT
+  end
+
+  let(:content) do
+    <<~CONTENT
+      1.0
+      -----
+      - Item 1 for v1.0
+      - Item 2 for v1.0
+
+      // Comment in the middle
+
+      0.9.0
+      -----
+      - Item 1 for v0.9.0
+      - Item 2 for v0.9.0
+    CONTENT
+  end
+
+  describe '#ios_update_release_notes' do
+    it 'adds a new section on RELEASE-NOTES.txt' do
+      in_tmp_dir do |tmp_dir|
+        # Arrange
+        release_notes_txt = File.join(tmp_dir, 'RELEASE-NOTES.txt')
+        File.write(release_notes_txt, content)
+
+        # Act
+        run_described_fastlane_action(
+          new_version: '1.0'
+        )
+
+        # Assert
+        expect(File.read(release_notes_txt)).to eq(new_section + content)
+      end
+    end
+
+    it 'adds a new section on the given file' do
+      in_tmp_dir do |tmp_dir|
+        # Arrange
+        changelog_md = File.join(tmp_dir, 'CHANGELOG.md')
+        File.write(changelog_md, content)
+
+        # Act
+        run_described_fastlane_action(
+          new_version: '1.0',
+          release_notes_file_path: changelog_md
+        )
+
+        # Assert
+        expect(File.read(changelog_md)).to eq(new_section + content)
+      end
+    end
+  end
+end