fastlane-plugin-wpmreleasetoolkit 5.6.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd2b56e6aa5cf05e5e464b66e8b136e05048c7cdadee95b43bb152ab6d451e9f
-  data.tar.gz: da440f83d0f87a6d2dd6c74684a149d381f157d0f0ce40157c12cd237ebed373
+  metadata.gz: a5ccc5cff47b793af8f4ab760dae506824b97736743751874e6ffe05da49c6d6
+  data.tar.gz: b505f57985fa018c5845437e38b9d62a82db73252fca4990d30bf2e5b8b6455e
 SHA512:
-  metadata.gz: e684c1a705d0fab1f9d3ce82f7feed96be8a4aa09a954a19db1a564c4b958654668a6d2b9c23ee41bdcfd39ec68104f3e44e877a8df6d2bb5773efbe706c1730
-  data.tar.gz: 9fb910e098bbcc54a8753aebb1c2776e0c6e889d20e042f2848a38a5e3ebbeb95ae7b8def13d4efa0fa0e06c050e24e3d80633642a4281e3ba194e55c148427b
+  metadata.gz: ef7e10048e6a7bd1795667f06e59ff4af01638ea2a3f47bb2742f3ea50bd1d52ae1c8b747e4fc8d2422599f216e9dc03ba334ace07f9a90dfa785630f937c9d7
+  data.tar.gz: 559bee78785335bcc564e04cafc52af9d5514f2d979598ce05c5837ba97b6378c70f0d919809fc6f4db5ca4e5f64db47ac90e430b058d5cd6d777ebf81cc54dc

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

@@ -9,7 +9,8 @@ module Fastlane
         UI.user_error!("Can't find any reference for key #{params[:import_key]}") if version.nil?
         UI.message "Downloading #{params[:file_path]} from #{params[:repository]} at version #{version} to #{params[:download_folder]}"
 
-        Fastlane::Helper::GithubHelper.download_file_from_tag(
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        github_helper.download_file_from_tag(
           repository: params[:repository],
           tag: "#{params[:github_release_prefix]}#{version}",
           file_path: params[:file_path],
@@ -57,6 +58,7 @@ module Fastlane
                                        description: 'The prefix which is used in the GitHub release title',
                                        type: String,
                                        optional: true),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end
 

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

@@ -3,8 +3,9 @@ require 'securerandom'
 module Fastlane
   module Actions
     module SharedValues
-      FIREBASE_TEST_RESULT = :FIREBASE_TEST_LOG_FILE
+      FIREBASE_TEST_RESULT = :FIREBASE_TEST_LOG_FILE # FirebaseTestLabResult object, for internal consumption
       FIREBASE_TEST_LOG_FILE_PATH = :FIREBASE_TEST_LOG_FILE_PATH
+      FIREBASE_TEST_MORE_DETAILS_URL = :FIREBASE_TEST_MORE_DETAILS_URL
     end
 
     class AndroidFirebaseTestAction < Action
@@ -45,13 +46,20 @@ module Fastlane
           key_file_path: params[:key_file]
         )
 
-        FastlaneCore::UI.test_failure! "Firebase Tests failed – more information can be found at #{result.more_details_url}" unless result.success?
+        Fastlane::Actions.lane_context[SharedValues::FIREBASE_TEST_MORE_DETAILS_URL] = result.more_details_url
 
-        UI.success 'Firebase Tests Complete'
+        if result.success?
+          UI.success 'Firebase Tests Complete'
+          return true
+        else
+          ui_method = params[:crash_on_test_failure] ? :test_failure! : :error
+          FastlaneCore::UI.send(ui_method, "Firebase Tests failed – more information can be found at #{result.more_details_url}")
+          return false
+        end
       end
 
       # Fastlane doesn't eagerly validate options for us, so we'll do it first to have control over
-      # when they're evalutated.
+      # when they're evaluated.
       def self.validate_options(params)
         available_options
           .reject { |opt| opt.optional || !opt.default_value.nil? }
@@ -180,9 +188,28 @@ module Fastlane
             optional: true,
             type: String
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :crash_on_test_failure,
+            description: 'If set to `true` (the default), will stop fastlane with `test_failure!`. ' \
+              + 'If `false`, the action will return the test status, without interrupting the rest of your Fastlane run on failure, letting the caller handle the failure on their side',
+            optional: true,
+            type: Boolean,
+            default_value: true
+          ),
         ]
       end
 
+      def self.output
+        [
+          ['FIREBASE_TEST_LOG_FILE_PATH', 'Path to the `output.log` file containing the logs or invoking the tests'],
+          ['FIREBASE_TEST_MORE_DETAILS_URL', 'URL to the Firebase Console dashboard showing the details of the test run (and failures, if any)'],
+        ]
+      end
+
+      def self.return_value
+        'True if the test succeeded, false if they failed'
+      end
+
       def self.authors
         ['Automattic']
       end

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

@@ -10,10 +10,12 @@ module Fastlane
         repository = params[:repository]
         milestone_title = params[:milestone]
 
-        milestone = Fastlane::Helper::GithubHelper.get_milestone(repository, milestone_title)
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        milestone = github_helper.get_milestone(repository, milestone_title)
+
         UI.user_error!("Milestone #{milestone_title} not found.") if milestone.nil?
 
-        Fastlane::Helper::GithubHelper.github_client().update_milestone(repository, milestone[:number], state: 'closed')
+        github_helper.update_milestone(repository: repository, number: milestone[:number], state: 'closed')
       end
 
       def self.description
@@ -45,6 +47,7 @@ module Fastlane
                                        description: 'The GitHub milestone',
                                        optional: false,
                                        type: String),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end
 

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

@@ -10,7 +10,8 @@ module Fastlane
       def self.run(params)
         require_relative '../../helper/github_helper'
 
-        reuse_identifier = Fastlane::Helper::GithubHelper.comment_on_pr(
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        reuse_identifier = github_helper.comment_on_pr(
           project_slug: params[:project],
           pr_number: params[:pr_number],
           body: params[:body],
@@ -41,12 +42,7 @@ module Fastlane
 
       def self.available_options
         [
-          FastlaneCore::ConfigItem.new(
-            key: :access_token,
-            env_name: 'GITHUB_TOKEN',
-            description: 'The GitHub token to use for posting the comment',
-            type: String
-          ),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
           FastlaneCore::ConfigItem.new(
             key: :reuse_identifier,
             description: 'If provided, the reuse identifier can identify an existing comment to overwrite',

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

@@ -9,15 +9,29 @@ module Fastlane
       def self.run(params)
         repository = params[:repository]
 
-        last_stone = Fastlane::Helper::GithubHelper.get_last_milestone(repository)
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        last_stone = github_helper.get_last_milestone(repository)
+
         UI.message("Last detected milestone: #{last_stone[:title]} due on #{last_stone[:due_on]}.")
+
         milestone_duedate = last_stone[:due_on]
         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]
+        # Because of the app stores review process, we submit the binary 3 days before the intended release date.
+        # Using 3 days is mostly for historical reasons, for a long time, we've been submitting apps on Friday and releasing them on Monday.
+        days_until_submission = params[:need_appstore_submission] ? (number_of_days_from_code_freeze_to_release - 3) : milestone_duration
+
         UI.message("Next milestone: #{newmilestone_number} due on #{newmilestone_duedate}.")
-        Fastlane::Helper::GithubHelper.create_milestone(repository, newmilestone_number, newmilestone_duedate, milestone_duration, number_of_days_from_code_freeze_to_release, params[:need_appstore_submission])
+
+        github_helper.create_milestone(
+          repository: repository,
+          title: newmilestone_number,
+          due_date: newmilestone_duedate,
+          days_until_submission: days_until_submission,
+          days_until_release: number_of_days_from_code_freeze_to_release
+        )
       end
 
       def self.description
@@ -62,6 +76,7 @@ module Fastlane
                                        optional: true,
                                        is_string: false,
                                        default_value: 14),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end
 

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

@@ -21,7 +21,8 @@ module Fastlane
           UI.user_error!("Can't find file #{file_path}!") unless File.exist?(file_path)
         end
 
-        Fastlane::Helper::GithubHelper.create_release(
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        github_helper.create_release(
           repository: repository,
           version: version,
           target: params[:target],
@@ -82,6 +83,7 @@ module Fastlane
                                        optional: true,
                                        default_value: false,
                                        is_string: false),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end
 

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

@@ -10,7 +10,8 @@ module Fastlane
         milestone = params[:milestone]
 
         # Get commit list
-        pr_list = Fastlane::Helper::GithubHelper.get_prs_for_milestone(repository, milestone)
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        pr_list = github_helper.get_prs_for_milestone(repository, milestone)
 
         File.open(report_path, 'w') do |file|
           pr_list.each do |data|
@@ -53,6 +54,7 @@ module Fastlane
                                        description: 'The name of the milestone we want to fetch the list of PRs for (e.g.: `16.9`)',
                                        optional: false,
                                        is_string: true),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end
 

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

@@ -11,7 +11,9 @@ module Fastlane
         UI.message "#{self.check_path(params[:orig_folder])} Original Screenshot Source: #{params[:orig_folder]}"
         UI.message "#{self.check_path(params[:metadata_folder])} Translation source: #{params[:metadata_folder]}"
 
-        config = helper.read_json(params[:config_file])
+        config = helper.read_config(params[:config_file])
+
+        helper.check_fonts_installed!(config: config) unless params[:skip_font_check]
 
         translationDirectories = subdirectories_for_path(params[:metadata_folder])
         imageDirectories = subdirectories_for_path(params[:orig_folder])
@@ -141,31 +143,34 @@ module Fastlane
                                        env_name: 'PROMOSS_ORIG',
                                        description: 'The directory containing the original screenshots',
                                        optional: false,
-                                       is_string: true),
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :output_folder,
                                        env_name: 'PROMOSS_OUTPUT',
                                        description: 'The path of the folder to save the promo screenshots',
                                        optional: false,
-                                       is_string: true),
-
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :metadata_folder,
                                        env_name: 'PROMOSS_METADATA_FOLDER',
                                        description: 'The directory containing the translation data',
                                        optional: false,
-                                       is_string: true),
-
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :config_file,
                                        env_name: 'PROMOSS_CONFIG_FILE',
                                        description: 'The path to the file containing the promo screenshot configuration',
                                        optional: true,
-                                       is_string: true,
+                                       type: String,
                                        default_value: 'screenshots.json'),
-
           FastlaneCore::ConfigItem.new(key: :force,
                                        env_name: 'PROMOSS_FORCE_CREATION',
                                        description: 'Overwrite existing promo screenshots without asking first?',
                                        optional: true,
-                                       is_string: false,
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :skip_font_check,
+                                       env_name: 'PROMOSS_SKIP_FONT_CHECK',
+                                       description: 'Skip the check verifying that needed fonts are installed and active',
+                                       optional: true,
+                                       type: Boolean,
                                        default_value: false),
         ]
       end

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

@@ -7,14 +7,19 @@ module Fastlane
       def self.run(params)
         repository = params[:repository]
         branch_name = params[:branch]
-        branch_prot = {}
 
         branch_url = "https://api.github.com/repos/#{repository}/branches/#{branch_name}"
-        branch_prot[:restrictions] = { url: "#{branch_url}/protection/restrictions", users_url: "#{branch_url}/protection/restrictions/users", teams_url: "#{branch_url}/protection/restrictions/teams", users: [], teams: [] }
-        branch_prot[:enforce_admins] = nil
-        branch_prot[:required_pull_request_reviews] = { url: "#{branch_url}/protection/required_pull_request_reviews", dismiss_stale_reviews: false, require_code_owner_reviews: false }
-
-        Fastlane::Helper::GithubHelper.github_client().unprotect_branch(repository, branch_name, branch_prot)
+        restrictions = { url: "#{branch_url}/protection/restrictions", users_url: "#{branch_url}/protection/restrictions/users", teams_url: "#{branch_url}/protection/restrictions/teams", users: [], teams: [] }
+        required_pull_request_reviews = { url: "#{branch_url}/protection/required_pull_request_reviews", dismiss_stale_reviews: false, require_code_owner_reviews: false }
+
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        github_helper.remove_branch_protection(
+          repository: repository,
+          branch: branch_name,
+          restrictions: restrictions,
+          enforce_admins: nil,
+          required_pull_request_reviews: required_pull_request_reviews
+        )
       end
 
       def self.description
@@ -46,6 +51,7 @@ module Fastlane
                                        description: 'The branch to unprotect',
                                        optional: false,
                                        type: String),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end
 

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

@@ -7,13 +7,19 @@ module Fastlane
       def self.run(params)
         repository = params[:repository]
         branch_name = params[:branch]
-        branch_prot = {}
 
         branch_url = "https://api.github.com/repos/#{repository}/branches/#{branch_name}"
-        branch_prot[:restrictions] = { url: "#{branch_url}/protection/restrictions", users_url: "#{branch_url}/protection/restrictions/users", teams_url: "#{branch_url}/protection/restrictions/teams", users: [], teams: [] }
-        branch_prot[:enforce_admins] = nil
-        branch_prot[:required_pull_request_reviews] = { url: "#{branch_url}/protection/required_pull_request_reviews", dismiss_stale_reviews: false, require_code_owner_reviews: false }
-        Fastlane::Helper::GithubHelper.github_client().protect_branch(repository, branch_name, branch_prot)
+        restrictions = { url: "#{branch_url}/protection/restrictions", users_url: "#{branch_url}/protection/restrictions/users", teams_url: "#{branch_url}/protection/restrictions/teams", users: [], teams: [] }
+        required_pull_request_reviews = { url: "#{branch_url}/protection/required_pull_request_reviews", dismiss_stale_reviews: false, require_code_owner_reviews: false }
+
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        github_helper.set_branch_protection(
+          repository: repository,
+          branch: branch_name,
+          restrictions: restrictions,
+          enforce_admins: nil,
+          required_pull_request_reviews: required_pull_request_reviews
+        )
       end
 
       def self.description
@@ -45,6 +51,7 @@ module Fastlane
                                        description: 'The branch to protect',
                                        optional: false,
                                        type: String),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end
 

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

@@ -9,7 +9,9 @@ module Fastlane
         milestone_title = params[:milestone]
         freeze = params[:freeze]
 
-        milestone = Fastlane::Helper::GithubHelper.get_milestone(repository, milestone_title)
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+        milestone = github_helper.get_milestone(repository, milestone_title)
+
         UI.user_error!("Milestone #{milestone_title} not found.") if milestone.nil?
 
         mile_title = milestone[:title]
@@ -27,7 +29,7 @@ module Fastlane
         end
 
         UI.message("New milestone: #{mile_title}")
-        Fastlane::Helper::GithubHelper.github_client().update_milestone(repository, milestone[:number], title: mile_title)
+        github_helper.update_milestone(repository: repository, number: milestone[:number], title: mile_title)
       end
 
       def self.is_frozen(milestone)
@@ -70,6 +72,7 @@ module Fastlane
                                        optional: false,
                                        default_value: true,
                                        is_string: false),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end
 

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

@@ -20,7 +20,15 @@ module Fastlane
           key = [file_name_hash, key].join('/')
         end
 
-        UI.user_error!("File already exists in S3 bucket #{bucket} at #{key}") if file_is_already_uploaded?(bucket, key)
+        if file_is_already_uploaded?(bucket, key)
+          message = "File already exists in S3 bucket #{bucket} at #{key}"
+          if params[:skip_if_exists]
+            UI.important("#{message}. Skipping upload.")
+            return key
+          else
+            UI.user_error!(message)
+          end
+        end
 
         UI.message("Uploading #{file_path} to: #{key}")
 
@@ -101,6 +109,13 @@ module Fastlane
             default_value: true,
             type: Boolean
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :skip_if_exists,
+            description: 'If the file already exists in the S3 bucket, skip the upload (and report it in the logs), instead of failing with `user_error!`',
+            optional: true,
+            default_value: false,
+            type: Boolean
+          ),
         ]
       end
 

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

@@ -2,12 +2,11 @@ module Fastlane
   module Actions
     class IosLintLocalizationsAction < Action
       def self.run(params)
-        violations = Hash.new([])
+        violations = nil
 
         loop do
-          # If we did `violations = self.run...` we'd lose the default value for missing key being `[]` that we set above with `Hash.new`.
-          # We want that default value so that we can use `+=` when adding the duplicate keys violations below.
-          violations = violations.merge(self.run_linter(params))
+          violations = self.run_linter(params)
+          violations.default = [] # Set the default value for when querying a missing key
 
           if params[:check_duplicate_keys]
             find_duplicated_keys(params).each do |language, duplicates|
@@ -49,18 +48,21 @@ module Fastlane
       def self.find_duplicated_keys(params)
         duplicate_keys = {}
 
-        files_to_lint = Dir.chdir(params[:input_dir]) do
-          Dir.glob('*.lproj/Localizable.strings').map do |file|
-            {
-              language: File.basename(File.dirname(file), '.lproj'),
-              path: File.join(params[:input_dir], file)
-            }
-          end
-        end
-
+        files_to_lint = Dir.glob('*.lproj/Localizable.strings', base: params[:input_dir])
         files_to_lint.each do |file|
-          duplicates = Fastlane::Helper::Ios::StringsFileValidationHelper.find_duplicated_keys(file: file[:path])
-          duplicate_keys[file[:language]] = duplicates.map { |key, value| "`#{key}` was found at multiple lines: #{value.join(', ')}" } unless duplicates.empty?
+          language = File.basename(File.dirname(file), '.lproj')
+          path = File.join(params[:input_dir], file)
+
+          file_type = Fastlane::Helper::Ios::L10nHelper.strings_file_type(path: path)
+          if file_type == :text
+            duplicates = Fastlane::Helper::Ios::StringsFileValidationHelper.find_duplicated_keys(file: path)
+            duplicate_keys[language] = duplicates.map { |key, value| "`#{key}` was found at multiple lines: #{value.join(', ')}" } unless duplicates.empty?
+          else
+            UI.important <<~WRONG_FORMAT
+              File `#{path}` is in #{file_type} format, while finding duplicate keys only make sense on files that are in ASCII-plist format.
+              Since your files are in #{file_type} format, you should probably disable the `check_duplicate_keys` option from this `#{self.action_name}` call.
+            WRONG_FORMAT
+          end
         end
 
         duplicate_keys

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

@@ -8,34 +8,25 @@ module Fastlane
 
   module Helper
     class GithubHelper
-      def self.github_token!
-        token = [
-          'GHHELPER_ACCESS', # For historical reasons / backward compatibility
-          'GITHUB_TOKEN',    # Used by the `gh` CLI tool
-        ].map { |key| ENV[key] }
-                .compact
-                .first
-
-        token || UI.user_error!('Please provide a GitHub authentication token via the `GITHUB_TOKEN` environment variable')
-      end
-
-      def self.github_client
-        @@client ||= begin
-          client = Octokit::Client.new(access_token: github_token!)
+      attr_reader :client
 
-          # Fetch the current user
-          user = client.user
-          UI.message("Logged in as: #{user.name}")
+      # Helper for GitHub Actions
+      #
+      # @param [String?] github_token GitHub OAuth access token
+      #
+      def initialize(github_token:)
+        @client = Octokit::Client.new(access_token: github_token)
 
-          # Auto-paginate to ensure we're not missing data
-          client.auto_paginate = true
+        # Fetch the current user
+        user = @client.user
+        UI.message("Logged in as: #{user.name}")
 
-          client
-        end
+        # Auto-paginate to ensure we're not missing data
+        @client.auto_paginate = true
       end
 
-      def self.get_milestone(repository, release)
-        miles = github_client().list_milestones(repository)
+      def get_milestone(repository, release)
+        miles = client.list_milestones(repository)
         mile = nil
 
         miles&.each do |mm|
@@ -51,15 +42,15 @@ module Fastlane
       # @param [String] milestone The name of the milestone we want to fetch the list of PRs for (e.g.: `16.9`)
       # @return [<Sawyer::Resource>] A list of the PRs for the given milestone, sorted by number
       #
-      def self.get_prs_for_milestone(repository, milestone)
-        github_client.search_issues(%(type:pr milestone:"#{milestone}" repo:#{repository}))[:items].sort_by(&:number)
+      def get_prs_for_milestone(repository, milestone)
+        client.search_issues(%(type:pr milestone:"#{milestone}" repo:#{repository}))[:items].sort_by(&:number)
       end
 
-      def self.get_last_milestone(repository)
+      def get_last_milestone(repository)
         options = {}
         options[:state] = 'open'
 
-        milestones = github_client().list_milestones(repository, options)
+        milestones = client.list_milestones(repository, options)
         return nil if milestones.nil?
 
         last_stone = nil
@@ -80,19 +71,42 @@ module Fastlane
         last_stone
       end
 
-      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')}"
+      # Creates a new milestone
+      #
+      # @param [String] repository The repository name, including the organization (e.g. `wordpress-mobile/wordpress-ios`)
+      # @param [String] title The name of the milestone we want to create (e.g.: `16.9`)
+      # @param [Time] due_date Milestone due date—which will also correspond to the code freeze date
+      # @param [Integer] days_until_submission Number of days from code freeze to submission to the App Store / Play Store
+      # @param [Integer] days_until_release Number of days from code freeze to release
+      #
+      def create_milestone(repository:, title:, due_date:, days_until_submission:, days_until_release:)
+        UI.user_error!('days_until_release must be greater than zero.') unless days_until_release.positive?
+        UI.user_error!('days_until_submission must be greater than zero.') unless days_until_submission.positive?
+        UI.user_error!('days_until_release must be greater or equal to days_until_submission.') unless days_until_release >= days_until_submission
+
+        submission_date = due_date.to_datetime.next_day(days_until_submission)
+        release_date = due_date.to_datetime.next_day(days_until_release)
+        comment = <<~MILESTONE_DESCRIPTION
+          Code freeze: #{due_date.to_datetime.strftime('%B %d, %Y')}
+          App Store submission: #{submission_date.strftime('%B %d, %Y')}
+          Release: #{release_date.strftime('%B %d, %Y')}
+        MILESTONE_DESCRIPTION
 
         options = {}
-        options[:due_on] = newmilestone_duedate
+        # == Workaround for GitHub API bug ==
+        #
+        # It seems that whatever date we send to the API, GitHub will 'floor' it to the date that seems to be at
+        # 00:00 PST/PDT and then discard the time component of the date we sent.
+        # This means that, when we cross the November DST change date, where the due date of the previous milestone
+        # was e.g. `2022-10-31T07:00:00Z` and `.next_day(14)` returns `2022-11-14T07:00:00Z` and we send that value
+        # for the `due_on` field via the API, GitHub ends up creating a milestone with a due of `2022-11-13T08:00:00Z`
+        # instead, introducing an off-by-one error on that due date.
+        #
+        # This is a bug in the GitHub API, not in our date computation logic.
+        # To solve this, we trick it by forcing the time component of the ISO date we send to be `12:00:00Z`.
+        options[:due_on] = due_date.strftime('%Y-%m-%dT12:00:00Z')
         options[:description] = comment
-        github_client().create_milestone(repository, newmilestone_number, options)
+        client.create_milestone(repository, title, options)
       end
 
       # Creates a Release on GitHub as a Draft
@@ -106,8 +120,8 @@ module Fastlane
       # @param [Array<String>] assets List of file paths to attach as assets to the release
       # @param [TrueClass|FalseClass] prerelease Indicates if this should be created as a pre-release (i.e. for alpha/beta)
       #
-      def self.create_release(repository:, version:, target: nil, description:, assets:, prerelease:)
-        release = github_client().create_release(
+      def create_release(repository:, version:, target: nil, description:, assets:, prerelease:)
+        release = client.create_release(
           repository,
           version, # tag name
           name: version, # release name
@@ -117,7 +131,7 @@ module Fastlane
           body: description
         )
         assets.each do |file_path|
-          github_client().upload_asset(release[:url], file_path, content_type: 'application/octet-stream')
+          client.upload_asset(release[:url], file_path, content_type: 'application/octet-stream')
         end
       end
 
@@ -129,15 +143,14 @@ module Fastlane
       # @param [String] download_folder The folder which the file should be downloaded into
       # @return [String] The path of the downloaded file, or nil if something went wrong
       #
-      def self.download_file_from_tag(repository:, tag:, file_path:, download_folder:)
+      def download_file_from_tag(repository:, tag:, file_path:, download_folder:)
         repository = repository.delete_prefix('/').chomp('/')
         file_path = file_path.delete_prefix('/').chomp('/')
         file_name = File.basename(file_path)
         download_path = File.join(download_folder, file_name)
 
-        download_url = github_client.contents(repository,
-                                              path: file_path,
-                                              ref: tag).download_url
+        download_url = client.contents(repository, path: file_path, ref: tag).download_url
+
         begin
           uri = URI.parse(download_url)
           uri.open do |remote_file|
@@ -151,8 +164,7 @@ module Fastlane
       end
 
       # Creates (or updates an existing) GitHub PR Comment
-      def self.comment_on_pr(project_slug:, pr_number:, body:, reuse_identifier: SecureRandom.uuid)
-        client = github_client
+      def comment_on_pr(project_slug:, pr_number:, body:, reuse_identifier: SecureRandom.uuid)
         comments = client.issue_comments(project_slug, pr_number)
 
         reuse_marker = "<!-- REUSE_ID: #{reuse_identifier} -->"
@@ -172,6 +184,58 @@ module Fastlane
 
         reuse_identifier
       end
+
+      # Update a milestone for a repository
+      #
+      # @param [String] repository The repository name (including the organization)
+      # @param [String] number The number of the milestone we want to fetch
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :title A unique title.
+      # @option options [String] :state
+      # @option options [String] :description A meaningful description
+      # @option options [Time] :due_on Set if the milestone has a due date
+      # @return [Milestone] A single milestone object
+      # @see http://developer.github.com/v3/issues/milestones/#update-a-milestone
+      #
+      def update_milestone(repository:, number:, **options)
+        client.update_milestone(repository, number, options)
+      end
+
+      # Remove the protection of a single branch from a repository
+      #
+      # @param [String] repository The repository name (including the organization)
+      # @param [String] branch The branch name
+      # @param [Hash] options A customizable set of options.
+      # @see https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection
+      #
+      def remove_branch_protection(repository:, branch:, **options)
+        client.unprotect_branch(repository, branch, options)
+      end
+
+      # Protects a single branch from a repository
+      #
+      # @param [String] repository The repository name (including the organization)
+      # @param [String] branch The branch name
+      # @param options [Hash] A customizable set of options.
+      # @see https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection
+      #
+      def set_branch_protection(repository:, branch:, **options)
+        client.protect_branch(repository, branch, options)
+      end
+
+      # Creates a GithubToken Fastlane ConfigItem
+      #
+      # @return [FastlaneCore::ConfigItem] The Fastlane ConfigItem for GitHub OAuth access token
+      #
+      def self.github_token_config_item
+        FastlaneCore::ConfigItem.new(
+          key: :github_token,
+          env_name: 'GITHUB_TOKEN',
+          description: 'The GitHub OAuth access token',
+          optional: false,
+          type: String
+        )
+      end
     end
   end
 end

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

@@ -36,6 +36,28 @@ module Fastlane
           end
         end
 
+        # Read a file line by line and iterate over it (just like `File.readlines` does),
+        # except that it also detects the encoding used by the file (using the BOM if present) when reading it,
+        # and then convert each line to UTF-8 before yielding it
+        #
+        # This is particularly useful if you need to then use a `RegExp` to match part of the lines you're iterating over,
+        # as the `RegExp` (which will typically be UTF-8) and the string you're matching with it have to use the same encoding
+        # (otherwise we would get a `Encoding::CompatibilityError`)
+        #
+        # @important If you are then using a `RegExp` to match the UTF-8 lines you iterate on,
+        # remember to use the `u` flag on it (`/…/u`) to make it UTF-8-aware too.
+        #
+        # @param [String] file The path to the file to read
+        # @yield each line read from the file, after converting it to the UTF-8 encoding
+        #
+        def self.read_utf8_lines(file)
+          # Be sure to guess file encoding using the Byte-Order-Mark, and fallback to UTF-8 if there's no BOM.
+          File.readlines(file, mode: 'rb:BOM|UTF-8').map do |line|
+            # Ensure the line is re-encoded to UTF-8 regardless of the encoding that was used in the input file
+            line.encode(Encoding::UTF_8)
+          end
+        end
+
         # Merge the content of multiple `.strings` files into a new `.strings` text file.
         #
         # @param [Hash<String, String>] paths The paths of the `.strings` files to merge together, associated with the prefix to prepend to each of their respective keys
@@ -68,11 +90,9 @@ module Fastlane
               all_keys_found += string_keys
 
               tmp_file.write("/* MARK: - #{File.basename(input_file)} */\n\n")
-              # Read line-by-line to reduce memory footprint during content copy; Be sure to guess file encoding using the Byte-Order-Mark.
-              File.readlines(input_file, mode: 'rb:BOM|UTF-8').each do |line|
+              # Read line-by-line to reduce memory footprint during content copy
+              read_utf8_lines(input_file).each do |line|
                 unless prefix.nil? || prefix.empty?
-                  # We need to ensure the line and RegExp are using the same encoding, so we transcode everything to UTF-8.
-                  line.encode!(Encoding::UTF_8)
                   # The `/u` modifier on the RegExps is to make them UTF-8
                   line.gsub!(/^(\s*")/u, "\\1#{prefix}") # Lines starting with a quote are considered to be start of a key; add prefix right after the quote
                   line.gsub!(/^(\s*)([A-Z0-9_]+)(\s*=\s*")/ui, "\\1\"#{prefix}\\2\"\\3") # Lines starting with an identifier followed by a '=' are considered to be an unquoted key (typical in InfoPlist.strings files for example)

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

@@ -11,25 +11,25 @@ module Fastlane
 
         TRANSITIONS = {
           root: {
-            /\s/ => :root,
+            /\s/u => :root,
             '/' => :maybe_comment_start,
             '"' => :in_quoted_key
           },
           maybe_comment_start: {
             '/' => :in_line_comment,
-            /\*/ => :in_block_comment
+            /\*/u => :in_block_comment
           },
           in_line_comment: {
             "\n" => :root,
-            /./ => :in_line_comment
+            /./u => :in_line_comment
           },
           in_block_comment: {
             /\*/ => :maybe_block_comment_end,
-            /./m => :in_block_comment
+            /./mu => :in_block_comment
           },
           maybe_block_comment_end: {
             '/' => :root,
-            /./m => :in_block_comment
+            /./mu => :in_block_comment
           },
           in_quoted_key: {
             '"' => lambda do |state, _|
@@ -37,25 +37,25 @@ module Fastlane
               state.buffer.string = ''
               :after_quoted_key_before_eq
             end,
-            /./ => lambda do |state, c|
+            /./u => lambda do |state, c|
               state.buffer.write(c)
               :in_quoted_key
             end
           },
           after_quoted_key_before_eq: {
-            /\s/ => :after_quoted_key_before_eq,
+            /\s/u => :after_quoted_key_before_eq,
             '=' => :after_quoted_key_and_eq
           },
           after_quoted_key_and_eq: {
-            /\s/ => :after_quoted_key_and_eq,
+            /\s/u => :after_quoted_key_and_eq,
             '"' => :in_quoted_value
           },
           in_quoted_value: {
             '"' => :after_quoted_value,
-            /./m => :in_quoted_value
+            /./mu => :in_quoted_value
           },
           after_quoted_value: {
-            /\s/ => :after_quoted_value,
+            /\s/u => :after_quoted_value,
             ';' => :root
           }
         }.freeze
@@ -70,7 +70,10 @@ module Fastlane
 
           state = State.new(context: :root, buffer: StringIO.new, in_escaped_ctx: false, found_key: nil)
 
-          File.readlines(file).each_with_index do |line, line_no|
+          # Using our `each_utf8_line` helper instead of `File.readlines` ensures we can also read files that are
+          # encoded in UTF-16, yet process each of their lines as a UTF-8 string, so that `RegExp#match?` don't throw
+          # an `Encoding::CompatibilityError` exception. (Note how all our `RegExp`s in `TRANSITIONS` have the `u` flag)
+          Fastlane::Helper::Ios::L10nHelper.read_utf8_lines(file).each_with_index do |line, line_no|
             line.chars.each_with_index do |c, col_no|
               # Handle escaped characters at a global level.
               # This is more straightforward than having to account for it in the `TRANSITIONS` table.

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

@@ -7,11 +7,11 @@ rescue LoadError
 end
 require 'json'
 require 'tempfile'
+require 'open3'
 require 'optparse'
 require 'pathname'
 require 'progress_bar'
 require 'parallel'
-require 'jsonlint'
 require 'chroma'
 require 'securerandom'
 
@@ -32,17 +32,65 @@ module Fastlane
         UI.user_error!('`drawText` not found – install it using `brew install automattic/build-tools/drawText`.') unless system('command -v drawText')
       end
 
-      def read_json(configFilePath)
+      def read_config(configFilePath)
         configFilePath = resolve_path(configFilePath)
 
         begin
-          return JSON.parse(open(configFilePath).read)
-        rescue
-          linter = JsonLint::Linter.new
-          linter.check(configFilePath)
-          linter.display_errors
+          # NOTE: While JSON is a subset of YAML and thus YAML.load_file would technically cover both cases at once, in practice
+          # `JSON.parse` is more lenient with JSON files than `YAML.load_file` is — especially, it accepts `// comments` in the
+          # JSON file, despite this not being allowed in the spec — hence why we still try with `JSON.parse` for `.json` files.
+          return File.extname(configFilePath) == '.json' ? JSON.parse(File.read(configFilePath)) : YAML.load_file(configFilePath)
+        rescue StandardError => e
+          UI.error(e)
+          UI.user_error!('Invalid JSON/YAML configuration. Please lint your config file to check for syntax errors.')
+        end
+      end
 
-          UI.user_error!('Invalid JSON configuration. See errors in log.')
+      # Checks that all required fonts are installed
+      #  - Visits the JSON config to find all the stylesheets referenced in it
+      #  - For each stylesheet, extract the first font of each `font-family` attribute found
+      #  - Finally, for each of those fonts, check that they exist and are activated.
+      #
+      # @param [Hash] config The promo screenshots configuration, as returned by #read_config
+      # @raise [UserError] Raises if at least one font is missing.
+      #
+      def check_fonts_installed!(config:)
+        # Find all stylesheets in the config
+        all_stylesheets = ([config['stylesheet']] + config['entries'].flat_map do |entry|
+          entry['attachments']&.map { |att| att['stylesheet'] }
+        end).compact.uniq
+
+        # Parse the first font in each `font-family` attribute found in all found CSS files.
+        # Only the first in each `font-family` font list matters, as others are fallbacks we don't want to use anyway.
+        font_families = all_stylesheets.flat_map do |s|
+          File.readlines(s).flat_map do |line|
+            attr = line.match(/font-family: (.*);/)&.captures&.first
+            attr.split(',').first.strip.gsub(/'(.*)'/, '\1').gsub(/"(.*)"/, '\1') unless attr.nil?
+          end
+        end.compact.uniq
+
+        # Verify that all fonts exists and are active—using a small swift script as there's no nice CLI for that
+        swift_script = <<~SWIFT
+          import AppKit
+
+          var exitCode: Int32 = 0
+          for fontName in CommandLine.arguments.dropFirst() {
+              if NSFont(name: fontName, size: NSFont.systemFontSize) != nil {
+                  print(" ✅ Font \\"\\(fontName)\\" found and active")
+              } else {
+                  print(" ❌ Font \\"\\(fontName)\\" not found, it is either not installed or disabled. Please install it using FontBook first.")
+                  exitCode = 1
+              }
+          }
+          exit(exitCode)
+        SWIFT
+
+        Tempfile.create(['fonts-check-', '.swift']) do |f|
+          f.write(swift_script)
+          f.close
+          oe, s = Open3.capture2e('/usr/bin/env', 'xcrun', 'swift', f.path, *font_families)
+          UI.command_output(oe)
+          UI.user_error!('Some fonts required by your stylesheets are missing. Please install them and try again.') unless s.success?
         end
       end
 
@@ -343,8 +391,8 @@ module Fastlane
       def open_image(path)
         path = resolve_path(path)
 
-        Magick::Image.read(path)  do
-          self.background_color = 'transparent'
+        Magick::Image.read(path) do |image|
+          image.background_color = 'transparent'
         end.first
       end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '5.6.0'
+    VERSION = '6.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Automattic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: jsonlint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement