fastlane-plugin-wpmreleasetoolkit 5.0.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe6a0ccccfa972725f15898f4d1894e9ce81a8ee60b27c436d1930cd68b58a59
-  data.tar.gz: 7c25d05bd642b368cfe8eac93bb7e26db77dd8380f4665a2521b9b7c0191d7d5
+  metadata.gz: 3a29c8bfbf5d7754cf59109a7dcf521efc91fab3b4314027db41f08a95390c7b
+  data.tar.gz: c4abdb17c40e79e17ce13a630ac9496768364b479a2496aa26fd9e4c633cae0c
 SHA512:
-  metadata.gz: 7dd36004e4d5f45cb747bd5d005937deb36cf8a638aa556460e059dbbae823fac182bd1f6af849972c053ecef91e2e57c6bbf64d771014f973b07a0502f6897d
-  data.tar.gz: 9d719a9f9ca3281d6a5d6045040782df58552966f91a3042edaaaf0e98e4fcd9c3a7a2758fdb2af550d5bf3dd8ce0a4c3af92c6b367ca054b1d11971d8cc6275
+  metadata.gz: d1050f9832b07111a7a8c1740e3ec95c2d59372449b84d901d8ec97f01f1f2ab47abf1383f743569f77666f04d76440e4d167a5d02b1e457da788b67ff8088a8
+  data.tar.gz: 8986d9c68fd931d1a384f8735b9d661bd7523fef0b88d18d0371379a61bbc3f25b6ede7b287d2b2b89dc6e2a315121a80324aacd1b127c64bdd996bc8e203fd8

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_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}]")
@@ -36,7 +38,7 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(
             key: :buildkite_token,
-            env_name: 'BUILDKITE_TOKEN',
+            env_names: %w[BUILDKITE_TOKEN BUILDKITE_API_TOKEN],
             description: 'Buildkite Personal Access Token',
             type: String,
             sensitive: true
@@ -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/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

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

@@ -40,7 +40,7 @@ module Fastlane
           target_files.each do |file|
             if file[0].to_s == key
               data = file[1]
-              msg = is_source ? source : d[1]
+              msg = is_source ? source : d[1].first || '' # In the JSON, each Hash value is an array, with zero or one entry
               update_key(target_locale, key, file, data, msg)
             end
           end
@@ -58,7 +58,7 @@ module Fastlane
             if file[0].to_s == key
               puts "Alternate: #{key}"
               data = file[1]
-              msg = is_source ? source : d[1]
+              msg = is_source ? source : d[1].first || '' # In the JSON, each Hash value is an array, with zero or one entry
               update_key(target_locale, key, file, data, msg)
             end
           end
@@ -66,7 +66,7 @@ module Fastlane
       end
 
       def update_key(target_locale, key, file, data, msg)
-        message_len = msg.to_s.length - 4 # Don't count JSON delimiters.
+        message_len = msg.length
         if (data.key?(:max_size)) && (data[:max_size] != 0) && ((message_len) > data[:max_size])
           if data.key?(:alternate_key)
             UI.message("#{target_locale} translation for #{key} exceeds maximum length (#{message_len}). Switching to the alternate translation.")

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '5.0.0'
+    VERSION = '5.3.0'
   end
 end

metadata

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