fastlane-plugin-wpmreleasetoolkit 5.1.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73836a5a9899d19389852c8bfd44db12633d1c6c3836f0a9d603c8484237a8f5
-  data.tar.gz: d8c802acdf7571eb6083a51aa1a1004ca10c5ff8aa8f0b323c5f20de4c008c45
+  metadata.gz: ab2ce164571f692b1378b62adade73faab9e319127ecd08b86a131a490d5185d
+  data.tar.gz: 3a0eb54e84aeeb1df3d71f5e7d91c586c3427c7055545fd28bc3b7a2cfcdb9cb
 SHA512:
-  metadata.gz: 4b42b103ae3de9219067cb691755fa66576e8f82561fd9a5b13a809d54271fe6389388bdb0fae5a3b9535bc2227c70e98139adbc9356972edc3c55d2432435db
-  data.tar.gz: 4ae0ce114dc2419ea4811c148740ec8629849ecf9e431aca6fa89e317f68cd00aba50cc8555a7a003b9332b9a84b6e77fe6271b452e97af9fc3b2ba271fbc359
+  metadata.gz: ab32b891a6e254a1406241624dd6117e233ebe541f40b405d614d2cb827e73f904b71afe9e1d1c8cf6f067c1285b05bb452d4137af7b8886ee20793e67e243c7
+  data.tar.gz: b61749dedc931a5e58cbf3357f6c24fcdf01e5a704648d9b082f51b4ce44b5f0b11457ce593efe684bb2c88eebfcbf70164de13bda199bcc1f988b3dbfbe825e

data/README.md

@@ -20,6 +20,21 @@ Read our [Contributing Guide](CONTRIBUTING.md) to learn about reporting issues,
 
 This guide also includes some tips about configuring your environment and IDE (e.g. VSCode) and how to run tests and documentation.
 
+## Doing a new Release
+
+When you need to do a new release of the `release-toolkit`, simply run `rake new_release` and follow the instructions.
+
+> This task will:
+>  - Show you the CHANGELOG/release notes it's about to use for that version
+>  - Deduce which version number to use according to [SemVer](https://semver.org/) rules, and ask you to confirm that version number
+>  - Create a `release/<x.y>` branch, update the version number in all the right places, and create a PR for those changes
+
+Submit the PR, adding the `Releases` label to it and adding the `owl-team` as reviewers.
+
+Once that PR is approved and merged, create a new GitHub Release, copy/pasting the CHANGELOG entries for that GH release's description.
+
+> Publishing the GitHub Release will create the associated tag as well, which will trigger the CI job that will ultimately `gem push` the gem on RubyGems.
+
 ## Security
 
 If you happen to find a security vulnerability, we would appreciate you letting us know at https://hackerone.com/automattic and allowing us to respond before disclosing the issue publicly.

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_firebase_test.rb

@@ -33,6 +33,7 @@ module Fastlane
           apk_path: params[:apk_path],
           test_apk_path: params[:test_apk_path],
           device: device,
+          test_targets: params[:test_targets],
           type: params[:type]
         )
 
@@ -106,6 +107,13 @@ module Fastlane
               UI.user_error!("Invalid test APK: #{value}") unless File.exist?(value)
             end
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :test_targets,
+            description: 'A list of one or more test target filters to apply',
+            type: String,
+            optional: true,
+            default_value: nil
+          ),
           FastlaneCore::ConfigItem.new(
             key: :model,
             description: 'The device model to use to run the test',

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_update_release_notes.rb

@@ -8,7 +8,7 @@ module Fastlane
         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 @@ module Fastlane
                                        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
 

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_trigger_build_action.rb

@@ -9,16 +9,18 @@ module Fastlane
         pipeline_name = {
           PIPELINE: params[:pipeline_file]
         }
+        options = {
+          branch: params[:branch],
+          commit: params[:commit],
+          env: params[:environment].merge(pipeline_name),
+          message: params[:message]
+        }.compact # remove entries with `nil` values from the Hash, if any
 
         client = Buildkit.new(token: params[:buildkite_token])
         response = client.create_build(
           params[:buildkite_organization],
           params[:buildkite_pipeline],
-          {
-            branch: params[:branch],
-            commit: params[:commit],
-            env: params[:environment].merge(pipeline_name)
-          }
+          options
         )
 
         response.state == 'scheduled' ? UI.message('Done!') : UI.crash!("Failed to start job\nError: [#{response}]")
@@ -64,6 +66,13 @@ module Fastlane
             type: String,
             default_value: 'HEAD'
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :message,
+            description: 'A custom message to show for the build in Buildkite\'s UI',
+            type: String,
+            optional: true,
+            default_value: nil
+          ),
           FastlaneCore::ConfigItem.new(
             key: :pipeline_file,
             description: 'The name of the pipeline file in the project',

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_new_milestone_action.rb

@@ -12,10 +12,12 @@ module Fastlane
         last_stone = Fastlane::Helper::GithubHelper.get_last_milestone(repository)
         UI.message("Last detected milestone: #{last_stone[:title]} due on #{last_stone[:due_on]}.")
         milestone_duedate = last_stone[:due_on]
-        newmilestone_duedate = (milestone_duedate.to_datetime.next_day(14).to_time).utc
+        milestone_duration = params[:milestone_duration]
+        newmilestone_duedate = (milestone_duedate.to_datetime.next_day(milestone_duration).to_time).utc
         newmilestone_number = Fastlane::Helper::Ios::VersionHelper.calc_next_release_version(last_stone[:title])
+        number_of_days_from_code_freeze_to_release = params[:number_of_days_from_code_freeze_to_release]
         UI.message("Next milestone: #{newmilestone_number} due on #{newmilestone_duedate}.")
-        Fastlane::Helper::GithubHelper.create_milestone(repository, newmilestone_number, newmilestone_duedate, params[:need_appstore_submission])
+        Fastlane::Helper::GithubHelper.create_milestone(repository, newmilestone_number, newmilestone_duedate, milestone_duration, number_of_days_from_code_freeze_to_release, params[:need_appstore_submission])
       end
 
       def self.description
@@ -48,6 +50,18 @@ module Fastlane
                                        optional: true,
                                        is_string: false,
                                        default_value: false),
+          FastlaneCore::ConfigItem.new(key: :milestone_duration,
+                                       env_name: 'GHHELPER_MILESTONE_DURATION',
+                                       description: 'Milestone duration in number of days',
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: 14),
+          FastlaneCore::ConfigItem.new(key: :number_of_days_from_code_freeze_to_release,
+                                       env_name: 'GHHELPER_NUMBER_OF_DAYS_FROM_CODE_FREEZE_TO_RELEASE',
+                                       description: 'Number of days from code freeze to release',
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: 14),
         ]
       end
 

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/extract_release_notes_for_version_action.rb

@@ -58,7 +58,7 @@ module Fastlane
 
       def self.details
         # Optional:
-        'Creates a release and uploads the provided assets'
+        'Given a file containing release notes and a version, extracts the notes for that version into a dedicated file.'
       end
 
       def self.available_options

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

@@ -8,7 +8,7 @@ module Fastlane
         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 @@ module Fastlane
                                        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
 

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_localize_helper.rb

@@ -212,8 +212,8 @@ module Fastlane
         def self.create_available_languages_file(res_dir:, locale_codes:)
           doc = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
             xml.comment('Warning: Auto-generated file, do not edit.')
-            xml.resources do
-              xml.send(:'string-array', name: 'available_languages', translatable: 'false') do
+            xml.resources('xmlns:tools': 'http://schemas.android.com/tools') do
+              xml.send(:'string-array', name: 'available_languages', translatable: 'false', 'tools:ignore': 'InconsistentArrays') do
                 locale_codes.each { |code| xml.item(code.gsub('-r', '_')) }
               end
             end
@@ -291,6 +291,7 @@ module Fastlane
             uri.open(options) { |f| Nokogiri::XML(f.read.gsub("\t", '    '), nil, Encoding::UTF_8.to_s) }
           rescue StandardError => e
             UI.error "Error downloading #{locale} - #{e.message}"
+            retry if e.is_a?(OpenURI::HTTPError) && UI.confirm("Retry downloading `#{locale}`?")
             return nil
           end
         end

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/github_helper.rb

@@ -70,7 +70,7 @@ module Fastlane
           else
             begin
               last_vcomps = last_stone[:title].split[0].split('.')
-              last_stone = mile if mile_vcomps[0] > last_vcomps[0] || mile_vcomps[1] > last_vcomps[1]
+              last_stone = mile if Integer(mile_vcomps[0]) > Integer(last_vcomps[0]) || Integer(mile_vcomps[1]) > Integer(last_vcomps[1])
             rescue StandardError
               puts 'Found invalid milestone'
             end
@@ -80,9 +80,13 @@ module Fastlane
         last_stone
       end
 
-      def self.create_milestone(repository, newmilestone_number, newmilestone_duedate, need_submission)
-        submission_date = need_submission ? newmilestone_duedate.to_datetime.next_day(11) : newmilestone_duedate.to_datetime.next_day(14)
-        release_date = newmilestone_duedate.to_datetime.next_day(14)
+      def self.create_milestone(repository, newmilestone_number, newmilestone_duedate, newmilestone_duration, number_of_days_from_code_freeze_to_release, need_submission)
+        # If there is a review process, we want to submit the binary 3 days before its release
+        #
+        # Using 3 days is mostly for historical reasons where we release the apps on Monday and submit them on Friday.
+        days_until_submission = need_submission ? (number_of_days_from_code_freeze_to_release - 3) : newmilestone_duration
+        submission_date = newmilestone_duedate.to_datetime.next_day(days_until_submission)
+        release_date = newmilestone_duedate.to_datetime.next_day(number_of_days_from_code_freeze_to_release)
         comment = "Code freeze: #{newmilestone_duedate.to_datetime.strftime('%B %d, %Y')} App Store submission: #{submission_date.strftime('%B %d, %Y')} Release: #{release_date.strftime('%B %d, %Y')}"
 
         options = {}

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_l10n_helper.rb

@@ -152,6 +152,7 @@ module Fastlane
             IO.copy_stream(uri.open(options), destination)
           rescue StandardError => e
             UI.error "Error downloading locale `#{locale}` — #{e.message} (#{uri})"
+            retry if e.is_a?(OpenURI::HTTPError) && UI.confirm("Retry downloading `#{locale}`?")
             return nil
           end
         end

data/lib/fastlane/plugin/wpmreleasetoolkit/models/firebase_test_runner.rb

@@ -20,20 +20,21 @@ module Fastlane
     # @param [FirebaseDevice] device The virtual device to run tests on.
     # @param [String] type The type of test to run.
     #
-    def self.run_tests(project_id:, apk_path:, test_apk_path:, device:, type: 'instrumentation')
+    def self.run_tests(project_id:, apk_path:, test_apk_path:, device:, test_targets: nil, type: 'instrumentation')
       raise "Unable to find apk: #{apk_path}" unless File.file?(apk_path)
       raise "Unable to find apk: #{test_apk_path}" unless File.file?(test_apk_path)
       raise "Invalid Type: #{type}" unless VALID_TEST_TYPES.include?(type)
 
-      command = Shellwords.join [
-        'gcloud', 'firebase', 'test', 'android', 'run',
-        '--project', project_id,
-        '--type', type,
-        '--app', apk_path,
-        '--test', test_apk_path,
-        '--device', device.to_s,
-        '--verbosity', 'info',
-      ]
+      params = {
+        project: project_id,
+        type: type,
+        app: apk_path,
+        test: test_apk_path,
+        'test-targets': test_targets,
+        device: device.to_s,
+        verbosity: 'info'
+      }.compact.flat_map { |k, v| ["--#{k}", v] }
+      command = Shellwords.join(['gcloud', 'firebase', 'test', 'android', 'run', *params])
 
       log_file_path = Fastlane::Actions.lane_context[:FIREBASE_TEST_LOG_FILE_PATH]
 

data/lib/fastlane/plugin/wpmreleasetoolkit/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '5.1.0'
+    VERSION = '5.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Automattic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport