fastlane-plugin-wpmreleasetoolkit 1.0.0

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

@@ -0,0 +1,44 @@
+module Fastlane
+  module Actions
+    class IosTagBuildAction < Action
+      def self.run(params)
+        require_relative '../../helper/ios/ios_version_helper.rb'
+        require_relative '../../helper/ios/ios_git_helper.rb'
+
+        itc_ver = Fastlane::Helper::Ios::VersionHelper.get_build_version()
+        int_ver = Fastlane::Helper::Ios::VersionHelper.get_internal_version() unless ENV['INTERNAL_CONFIG_FILE'].nil?
+        Fastlane::Helper::GitHelper.create_tag(itc_ver)
+        Fastlane::Helper::GitHelper.create_tag(int_ver) unless int_ver.nil?
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Tags the current build'
+      end
+
+      def self.details
+        'Tags the current build'
+      end
+
+      def self.available_options
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Fastlane
+  module Actions
+    class IosUpdateMetadataAction < Action
+      def self.run(params)
+        require_relative '../../helper/ios/ios_git_helper.rb'
+
+        Fastlane::Helper::Ios::GitHelper.update_metadata()
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Downloads translated metadata from the translation system'
+      end
+
+      def self.details
+        'Downloads translated metadata from the translation system'
+      end
+
+      def self.available_options
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+module Fastlane
+  module Actions
+    class IosUpdateMetadataSourceAction < Action
+      def self.run(params)
+        # Check local repo status
+        other_action.ensure_git_status_clean()
+
+        other_action.gp_update_metadata_source(po_file_path: params[:po_file_path],
+                                               source_files: params[:source_files],
+                                               release_version: params[:release_version])
+
+        Action.sh("git add #{params[:po_file_path]}")
+        params[:source_files].each do |_key, file|
+          Action.sh("git add #{file}")
+        end
+
+        repo_status = Actions.sh('git status --porcelain')
+        repo_clean = repo_status.empty?
+        unless repo_clean
+          Action.sh('git commit -m "Update metadata strings"')
+          Action.sh('git push')
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Updates the AppStoreStrings.po file with the data from text source files'
+      end
+
+      def self.details
+        'Updates the AppStoreStrings.po file with the data from text source files'
+      end
+
+      def self.available_options
+        # Define all options your action supports.
+
+        # Below a few examples
+        [
+          FastlaneCore::ConfigItem.new(key: :po_file_path,
+                                       env_name: 'FL_IOS_UPDATE_METADATA_SOURCE_PO_FILE_PATH',
+                                       description: 'The path of the .po file to update',
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                                       UI.user_error!("No .po file path for UpdateMetadataSourceAction given, pass using `po_file_path: 'file path'`") unless value && (!value.empty?)
+                                                       UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                                     end),
+          FastlaneCore::ConfigItem.new(key: :release_version,
+                                       env_name: 'FL_IOS_UPDATE_METADATA_SOURCE_RELEASE_VERSION',
+                                       description: 'The release version of the app (to use to mark the release notes)',
+                                       verify_block: proc do |value|
+                                                       UI.user_error!("No relase version for UpdateMetadataSourceAction given, pass using `release_version: 'version'`") unless value && (!value.empty?)
+                                                     end),
+          FastlaneCore::ConfigItem.new(key: :source_files,
+                                       env_name: 'FL_IOS_UPDATE_METADATA_SOURCE_SOURCE_FILES',
+                                       description: 'The hash with the path to the source files and the key to use to include their content',
+                                       is_string: false,
+                                       verify_block: proc do |value|
+                                                       UI.user_error!("No source file hash for UpdateMetadataSourceAction given, pass using `source_files: 'source file hash'`") unless value && (!value.empty?)
+                                                     end),
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+module Fastlane
+  module Actions
+    class IosUpdateReleaseNotesAction < Action
+      def self.run(params)
+        UI.message 'Updating the release notes...'
+
+        require_relative '../../helper/ios/ios_version_helper.rb'
+        require_relative '../../helper/release_notes_helper.rb'
+        require_relative '../../helper/git_helper.rb'
+
+        path = File.join(ENV['PROJECT_ROOT_FOLDER'] || '.', 'RELEASE-NOTES.txt')
+        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)
+        Fastlane::Helper::GitHelper.commit(message: "Release Notes: add new section for next version (#{next_version})", files: path, push: true)
+
+        UI.message 'Done.'
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Updates the release notes file for the next app version'
+      end
+
+      def self.details
+        'Updates the release notes file for the next app version'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :new_version,
+                                       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),
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module Fastlane
+  module Actions
+    class IosValidateCiBuildAction < Action
+      def self.run(params)
+        require_relative '../../helper/ios/ios_git_helper.rb'
+        require_relative '../../helper/ios/ios_version_helper.rb'
+
+        version = Fastlane::Helper::Ios::VersionHelper.get_public_version()
+        head_tags = Fastlane::Helper::GitHelper.list_tags_on_current_commit()
+        UI.user_error!('HEAD is not on tag. Aborting!') if head_tags.empty?
+
+        return head_tags.include?(version) # Current commit is tagged with "version" tag
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Validate the build on CI environment'
+      end
+
+      def self.details
+        'Validate the build on CI environment'
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+module Fastlane
+  module Helper
+    # Basic line handler
+    class MetadataBlock
+      attr_reader :block_key
+
+      def initialize(block_key)
+        @block_key = block_key
+      end
+
+      def handle_line(fw, line)
+        fw.puts(line) # Standard line handling: just copy
+      end
+
+      def is_handler_for(key)
+        true
+      end
+    end
+
+    class UnknownMetadataBlock < MetadataBlock
+      attr_reader :content_file_path
+
+      def initialize
+        super(nil)
+      end
+    end
+
+    class StandardMetadataBlock < MetadataBlock
+      attr_reader :content_file_path
+
+      def initialize(block_key, content_file_path)
+        super(block_key)
+        @content_file_path = content_file_path
+      end
+
+      def is_handler_for(key)
+        key == @block_key.to_s
+      end
+
+      def handle_line(fw, line)
+        # put the new content on block start
+        # and skip all the other content
+        generate_block(fw) if line.start_with?('msgctxt')
+      end
+
+      def generate_block(fw)
+        # init
+        fw.puts("msgctxt \"#{@block_key}\"")
+        line_count = File.foreach(@content_file_path).inject(0) { |c, _line| c + 1 }
+
+        if line_count <= 1
+          # Single line output
+          fw.puts("msgid \"#{File.open(@content_file_path, 'r').read}\"")
+        else
+          # Multiple line output
+          fw.puts('msgid ""')
+
+          # insert content
+          File.open(@content_file_path, 'r').each do |line|
+            fw.puts("\"#{line.strip}\\n\"")
+          end
+        end
+
+        # close
+        fw.puts('msgstr ""')
+        fw.puts('')
+      end
+    end
+
+    class ReleaseNoteMetadataBlock < StandardMetadataBlock
+      attr_reader :new_key, :keep_key, :rel_note_key, :release_version
+
+      def initialize(block_key, content_file_path, release_version)
+        super(block_key, content_file_path)
+        @rel_note_key = 'release_note'
+        @release_version = release_version
+        generate_keys(release_version)
+      end
+
+      def generate_keys(release_version)
+        values = release_version.split('.')
+        version_major = Integer(values[0])
+        version_minor = Integer(values[1])
+        @new_key = "#{@rel_note_key}_#{version_major.to_s.rjust(2, '0')}#{version_minor}"
+
+        version_major = version_major - 1 if version_minor == 0
+        version_minor = version_minor == 0 ? 9 : version_minor - 1
+
+        @keep_key = "#{@rel_note_key}_#{version_major.to_s.rjust(2, '0')}#{version_minor}"
+      end
+
+      def is_handler_for(key)
+        values = key.split('_')
+        key.start_with?(@rel_note_key) && values.length == 3 && is_int?(values[2].sub(/^[0]*/, ''))
+      end
+
+      def handle_line(fw, line)
+        # put content on block start or if copying the latest one
+        # and skip all the other content
+        if line.start_with?('msgctxt')
+          key = extract_key(line)
+          @is_copying = (key == @keep_key)
+          generate_block(fw) if @is_copying
+        end
+
+        fw.puts(line) if @is_copying
+      end
+
+      def generate_block(fw)
+        # init
+        fw.puts("msgctxt \"#{@new_key}\"")
+        fw.puts('msgid ""')
+        fw.puts("\"#{@release_version}:\\n\"")
+
+        # insert content
+        File.open(@content_file_path, 'r').each do |line|
+          fw.puts("\"#{line.strip}\\n\"")
+        end
+
+        # close
+        fw.puts('msgstr ""')
+        fw.puts('')
+      end
+
+      def extract_key(line)
+        line.split(' ')[1].tr('\"', '')
+      end
+
+      def is_int?(value)
+        true if Integer(value) rescue false
+      end
+    end
+
+    class ReleaseNoteShortMetadataBlock < ReleaseNoteMetadataBlock
+      def initialize(block_key, content_file_path, release_version)
+        super(block_key, content_file_path, release_version)
+        @rel_note_key = 'release_note_short'
+        @release_version = release_version
+        generate_keys(release_version)
+      end
+
+      def is_handler_for(key)
+        values = key.split('_')
+        key.start_with?(@rel_note_key) && values.length == 4 && is_int?(values[3].sub(/^[0]*/, ''))
+      end
+
+      def generate_block(fw)
+        super(fw) unless File.zero?(@content_file_path)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fastlane
+  module Helper
+    module Android
+      # Helper methods to execute git-related operations that are specific to Android projects
+      #
+      module GitHelper
+        # Commit and push the files that are modified when we bump version numbers on an iOS project
+        #
+        # This typically commits and pushes the `build.gradle` file inside the project subfolder.
+        #
+        # @env PROJECT_ROOT_FOLDER The path to the git root of the project
+        # @env PROJECT_NAME The name of the directory containing the project code (especially containing the `build.gradle` file)
+        #
+        def self.commit_version_bump
+          Fastlane::Helper::GitHelper.commit(
+            message: 'Bump version number',
+            files: File.join(ENV['PROJECT_ROOT_FOLDER'], ENV['PROJECT_NAME'], 'build.gradle'),
+            push: true
+          )
+        end
+
+        # Calls the `tools/update-translations.sh` script from the project repo, then lint them using the provided gradle task
+        #
+        # Deprecated. Use the `android_download_translations` action instead.
+        #
+        # @env PROJECT_ROOT_FOLDER The path to the git root of the project
+        # @env PROJECT_NAME The name of the directory containing the project code (especially containing the `build.gradle` file)
+        #
+        # @param [String] validate_translation_command The name of the gradle task to run to validate the translations
+        #
+        # @todo Remove this once every client has migrated to `android_download_translations` and we got rid of that legacy action.
+        #
+        def self.update_metadata(validate_translation_command)
+          Action.sh('./tools/update-translations.sh')
+          Action.sh('git', 'submodule', 'update', '--init', '--recursive')
+          Action.sh('./gradlew', validate_translation_command)
+
+          res_dir = File.join(ENV['PROJECT_ROOT_FOLDER'], ENV['PROJECT_NAME'], 'src', 'main', 'res')
+          Fastlane::Helper::GitHelper.commit(message: 'Update translations', files: res_dir, push: true)
+        end
+      end
+    end
+  end
+end