fastlane-plugin-wpmreleasetoolkit 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccdaad31840825f4e31a868d02be5bd94a50b8dfe08905b75a07d9c2de187158
-  data.tar.gz: 679d9fe6250aeadd808ddbd2d5baf23ce8ff0f920dd52a99cabf1b751ec74fc2
+  metadata.gz: a118f64ccb017604c68c8f62c56b91d4bea3ec92f26e2942ec28caf681a811a7
+  data.tar.gz: 4c09125195256749d839aac630c4393fab86f08363304b70b6e3d452c8aae96a
 SHA512:
-  metadata.gz: f972a9987b33dad7bf2eee79e378fb40ba5ed174c4885b983dccd1ee86ddb1ca3cdc998c50c3ce0d7dddaec5d0c4508d4baab3a81ef62f5e3e6759b70f68954f
-  data.tar.gz: bf06d3515cd1994574d4b0e0d01b67c4554106c342d86cf87dd7e72d572b5b1e6129cc7757a7d64b42adaab0c791185b9d3544f244cf338bf77cb10de0ac99da
+  metadata.gz: '04158059883cdf0a9f19077a616020fe027fc25a574d8e84605ca40d948763a33dd7373dbc526a26bc0e99f3fab4c20b38e2f10799bc2dd9bd953437fe6b7fb5'
+  data.tar.gz: 741ea4ad0ba1b022bd856839d72c4a4847cfc0d5377c350fea687e85b685bca3cb95206e5ae6999f2c1792938966578376e58d8810cd719fc5cbf2e8c866ebcb

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

@@ -0,0 +1,89 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      PR_COMMENT_REUSE_IDENTIFIER = :PR_COMMENT_REUSE_IDENTIFIER
+    end
+
+    class CommentOnPrAction < Action
+      def self.run(params)
+        require_relative '../../helper/github_helper'
+
+        reuse_identifier = Fastlane::Helper::GithubHelper.comment_on_pr(
+          project_slug: params[:project],
+          pr_number: params[:pr_number],
+          body: params[:body],
+          reuse_identifier: params[:reuse_identifier]
+        )
+
+        Actions.lane_context[SharedValues::PR_COMMENT_REUSE_IDENTIFIER] = reuse_identifier
+
+        reuse_identifier
+      end
+
+      def self.description
+        'Post a comment on a given PR number (optionally updating an existing one)'
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.details
+        <<~DETAILS
+          If used just once, this method makes it nice and easy to post a quick comment to a GitHub PR.
+
+          Subsequent runs will allow you to update an existing comment as many times as you need to
+          (e.g. across multiple CI runs), by using a `:reuse_identifier` to identify the comment to update.
+        DETAILS
+      end
+
+      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
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :reuse_identifier,
+            description: 'If provided, the reuse identifier can identify an existing comment to overwrite',
+            type: String,
+            default_value: nil
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :project,
+            description: 'The project slug (ex: `wordpress-mobile/wordpress-ios`)',
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :pr_number,
+            description: 'The PR number',
+            type: Integer
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :body,
+            description: 'The content of the comment',
+            type: String
+          ),
+        ]
+      end
+
+      def self.output
+        [
+          ['PR_COMMENT_REUSE_IDENTIFIER', 'The `reuse_identifier` for the most recently posted comment'],
+        ]
+      end
+
+      def self.return_value
+        'The `reuse_identifier` for the posted comment (useful for updating it later, if needed)'
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -11,6 +11,8 @@ module Fastlane
         version = params[:version]
         assets = params[:release_assets]
         release_notes = params[:release_notes_file_path].nil? ? '' : File.read(params[:release_notes_file_path])
+        # Replace full URLS to PRs/Issues with shorthand, because GitHub does not render them properly otherwise.
+        release_notes.gsub!(%r{https://github.com/([^/]*/[^/]*)/(pulls?|issues?)/([0-9]*)}, '\1#\3')
         prerelease = params[:prerelease]
 
         UI.message("Creating draft release #{version} in #{repository}.")

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

@@ -0,0 +1,115 @@
+module Fastlane
+  module Actions
+    class IosGenerateStringsFileFromCodeAction < Action
+      def self.run(params)
+        files = files_matching(paths: params[:paths], exclude: params[:exclude])
+        flags = [('-q' if params[:quiet]), ('-SwiftUI' if params[:swiftui])].compact
+        flags += Array(params[:routines]).flat_map { |routine| ['-s', routine] }
+        cmd = ['genstrings', '-o', params[:output_dir], *flags, *files]
+        out = Actions.sh_control_output(*cmd, print_command: FastlaneCore::Globals.verbose?, print_command_output: true)
+        out = out.scrub.strip.split("\n")
+        errors = out.select { |line| line.include?('genstrings: error: ') }
+        UI.user_error!(errors.join("\n")) unless !params[:fail_on_error] || errors.empty?
+        out
+      end
+
+      # Adds the proper `**/*.{m,swift}` to the list of paths
+      def self.glob_pattern(path)
+        if path.end_with?('**') || path.end_with?('**/')
+          File.join(path, '*.{m,swift}')
+        elsif File.directory?(path) || path.end_with?('/')
+          File.join(path, '**', '*.{m,swift}')
+        else
+          path
+        end
+      end
+
+      def self.files_matching(paths:, exclude:)
+        globbed_paths = paths.map { |p| glob_pattern(p) }
+        Dir.glob(globbed_paths).reject do |file|
+          exclude&.any? { |ex| File.fnmatch?(ex, file) }
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Generate the .strings files from your Objective-C and Swift code'
+      end
+
+      def self.details
+        <<~DETAILS
+          Uses `genstrings` to generate the `.strings` files from your Objective-C and Swift code.
+          (especially `Localizable.strings` but it could generate more if the code uses custom tables).
+
+          You can provide a list of paths to scan but also paths to exclude. Both supports glob patterns.
+          You can also optionally provide a list of custom "routines" (aka macros or functions) that
+          `genstrings` should parse in addition to the usual `NSLocalizedString`. (see `-s` option of `genstrings`).
+
+          Tip: support for custom routines is useful if some of your targets define a helper function e.g.
+          `PodLocalizedString` to wrap calls to `Bundle.localizedString(forKey: key, value: value, table: nil)`,
+          just like the build-in `NSLocalizedString` does, but providing a custom bundle to look up the strings from.
+        DETAILS
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :paths,
+                                       env_name: 'FL_IOS_GENERATE_STRINGS_FILE_FROM_CODE_PATHS',
+                                       description: 'Array of paths to scan for `.m` and `.swift` files. The entries can also contain glob patterns',
+                                       type: Array,
+                                       default_value: ['.']),
+          FastlaneCore::ConfigItem.new(key: :exclude,
+                                       env_name: 'FL_IOS_GENERATE_STRINGS_FILE_FROM_CODE_EXCLUDE',
+                                       description: 'Array of paths or glob patterns to exclude from scanning',
+                                       type: Array,
+                                       default_value: []),
+          FastlaneCore::ConfigItem.new(key: :routines,
+                                       env_name: 'FL_IOS_GENERATE_STRINGS_FILE_FROM_CODE_ROUTINES',
+                                       description: 'Base name of the alternate methods to be parsed in addition to the standard `NSLocalizedString()` one. See the `-s` option in `man genstrings`',
+                                       type: Array,
+                                       default_value: []),
+          FastlaneCore::ConfigItem.new(key: :quiet,
+                                       env_name: 'FL_IOS_GENERATE_STRINGS_FILE_FROM_CODE_QUIET',
+                                       description: 'In quiet mode, `genstrings` will log warnings about duplicate values, but not about duplicate comments',
+                                       is_string: false, # Boolean
+                                       default_value: true),
+          FastlaneCore::ConfigItem.new(key: :swiftui,
+                                       env_name: 'FL_IOS_GENERATE_STRINGS_FILE_FROM_CODE_SWIFTUI',
+                                       description: "Should we include SwiftUI's `Text()` when parsing code with `genstrings`",
+                                       is_string: false, # Boolean
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :output_dir,
+                                       env_name: 'FL_IOS_GENERATE_STRINGS_FILE_FROM_CODE_OUTPUT_DIR',
+                                       description: 'The path to the directory where the generated `.strings` files should be created',
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :fail_on_error,
+                                       env_name: 'FL_IOS_GENERATE_STRINGS_FILE_FROM_CODE_FAIL_ON_ERROR',
+                                       description: 'If true, will fail with user_error! if `genstrings` printed any error while parsing',
+                                       is_string: false, # Boolean
+                                       default_value: true),
+        ]
+      end
+
+      def self.return_type
+        # Describes what type of data is expected to be returned
+        # see RETURN_TYPES in https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/action.rb
+        :array_of_strings
+      end
+
+      def self.return_value
+        'List of warning lines generated by genstrings on stdout'
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

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

@@ -20,16 +20,15 @@ module Fastlane
       end
 
       def self.details
-        'Gathers the string to localise'
-      end
-
-      def self.available_options
+        'Gathers the string to localise. Deprecated in favor of the new `ios_generate_strings_file_from_code`'
       end
 
-      def self.output
+      def self.category
+        :deprecated
       end
 
-      def self.return_value
+      def self.deprecated_notes
+        'This action is deprecated in favor of `ios_generate_strings_file_from_code`'
       end
 
       def self.authors

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

@@ -1,23 +1,37 @@
 require 'fastlane_core/ui/ui'
 require 'octokit'
 require 'open-uri'
+require 'securerandom'
 
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
 
   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 = Octokit::Client.new(access_token: ENV['GHHELPER_ACCESS'])
+        @@client ||= begin
+          client = Octokit::Client.new(access_token: github_token!)
 
-        # Fetch the current user
-        user = client.user
-        UI.message("Logged in as: #{user.name}")
+          # Fetch the current user
+          user = client.user
+          UI.message("Logged in as: #{user.name}")
 
-        # Auto-paginate to ensure we're not missing data
-        client.auto_paginate = true
+          # Auto-paginate to ensure we're not missing data
+          client.auto_paginate = true
 
-        client
+          client
+        end
       end
 
       def self.get_milestone(repository, release)
@@ -117,8 +131,11 @@ module Fastlane
         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
         begin
-          uri = URI.parse("https://raw.githubusercontent.com/#{repository}/#{tag}/#{file_path}")
+          uri = URI.parse(download_url)
           uri.open do |remote_file|
             File.write(download_path, remote_file.read)
           end
@@ -128,6 +145,29 @@ module Fastlane
 
         download_path
       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
+        comments = client.issue_comments(project_slug, pr_number)
+
+        reuse_marker = "<!-- REUSE_ID: #{reuse_identifier} -->"
+
+        existing_comment = comments.find do |comment|
+          # Only match comments posted by the owner of the GitHub Token, and with the given reuse ID
+          comment.user.id == client.user.id and comment.body.include?(reuse_marker)
+        end
+
+        comment_body = reuse_marker + body
+
+        if existing_comment.nil?
+          client.add_comment(project_slug, pr_number, comment_body)
+        else
+          client.update_comment(project_slug, existing_comment.id, comment_body)
+        end
+
+        reuse_identifier
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '2.1.0'
+    VERSION = '2.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Lorenzo Mattei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -408,6 +408,7 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/check_translation_progress.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/circleci_trigger_job_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/close_milestone_action.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/actions/common/comment_on_pr.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_new_milestone_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_release_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/extract_release_notes_for_version_action.rb
@@ -439,6 +440,7 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_current_branch_is_hotfix.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_final_tag.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_finalize_prechecks.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_generate_strings_file_from_code.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_get_app_version.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_get_build_version.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_get_store_app_sizes.rb