fastlane-plugin-wpmreleasetoolkit 1.0.0

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

@@ -0,0 +1,63 @@
+module Fastlane
+  module Actions
+    class AndroidCreateXmlReleaseNotesAction < Action
+      def self.run(params)
+        require_relative '../../helper/android/android_git_helper.rb'
+
+        release_notes_path = params[:download_path] + '/release_notes.xml'
+        open(release_notes_path, 'w') do |f|
+          params[:locales].each do |loc|
+            puts "Looking for language: #{loc[1]}"
+            complete_path = "#{params[:download_path]}/#{loc[1]}/changelogs/#{params[:build_number]}.txt"
+            if File.exist?(complete_path)
+              f.puts("<#{loc[1]}>")
+              f.puts(File.open(complete_path).read)
+              f.puts("</#{loc[1]}>\n")
+            else
+              UI.message("File #{complete_path} not found. Skipping language #{loc[1]}")
+            end
+          end
+        end
+      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
+        [
+          FastlaneCore::ConfigItem.new(key: :download_path,
+                                       env_name: 'ANDROID_XML_NOTES_DOWNLOAD_PATH',
+                                       description: 'The path to the folder with the release notes',
+                                       optional: false,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :build_number,
+                                       env_name: 'ANDROID_XML_NOTES_BUILD_NUMBER',
+                                       description: 'The build number of the release notes',
+                                       optional: false,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :locales,
+                                       env_name: 'FL_DOWNLOAD_METADATA_LOCALES',
+                                       description: 'The hash with the GLotPress locale and the project locale association',
+                                       is_string: false),
+        ]
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      ANDROID_CURRENT_BRANCH_IS_HOTFIX_CUSTOM_VALUE = :ANDROID_CURRENT_BRANCH_IS_HOTFIX_CUSTOM_VALUE
+    end
+
+    class AndroidCurrentBranchIsHotfixAction < Action
+      def self.run(params)
+        require_relative '../../helper/android/android_version_helper.rb'
+        Fastlane::Helper::Android::VersionHelper.is_hotfix?(Fastlane::Helper::Android::VersionHelper.get_release_version)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Checks if the current branch is for a hotfix'
+      end
+
+      def self.details
+        'Checks if the current branch is for a hotfix'
+      end
+
+      def self.available_options
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+        'True if the branch is for a hotfix, false otherwise'
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module Fastlane
+  module Actions
+    class AndroidDownloadFileByVersionAction < Action
+      def self.run(params)
+        require_relative '../../helper/android/android_localize_helper.rb'
+        require_relative '../../helper/github_helper'
+
+        version = Fastlane::Helper::Android::VersionHelper.get_library_version_from_gradle_config(import_key: params[:import_key])
+        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(
+          repository: params[:repository],
+          tag: "#{params[:github_release_prefix]}#{version}",
+          file_path: params[:file_path],
+          download_folder: params[:download_folder]
+        )
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Downloads a file from a GitHub release based on the version used by the client app'
+      end
+
+      def self.details
+        'This action extracts the version of the library which is imported by the client app' \
+        'and downloads the request file from the relevant GitHub release'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :library_name,
+                                       description: 'The display name of the library',
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :import_key,
+                                       description: 'The key which is used in build.gradle to reference the version of the library to import',
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :repository,
+                                       description: "The GitHub repository slug ('<orgname>/<reponame>') which hosts the library project",
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       description: 'The path of the file to download',
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :download_folder,
+                                       description: 'The download folder',
+                                       type: String,
+                                       optional: true,
+                                       default_value: Dir.tmpdir()),
+          FastlaneCore::ConfigItem.new(key: :github_release_prefix,
+                                       description: 'The prefix which is used in the GitHub release title',
+                                       type: String,
+                                       optional: true),
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+        'The path where the file was downloaded to (typically <download_folder>/<basename(file_path)>), or nil if there was an issue downloading the file'
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# This action is the new version of android_update_metadata (AndroidUpdateMetadataAction) and should now be used instead of that one
+
+module Fastlane
+  module Actions
+    class AndroidDownloadTranslationsAction < Action
+      def self.run(params)
+        require_relative '../../helper/android/android_localize_helper.rb'
+        require_relative '../../helper/git_helper.rb'
+
+        res_dir = File.join(ENV['PROJECT_ROOT_FOLDER'] || '.', params[:res_dir])
+
+        Fastlane::Helper::Android::LocalizeHelper.create_available_languages_file(
+          res_dir: res_dir,
+          locale_codes: [params[:source_locale]] + params[:locales].map { |h| h[:android] }
+        )
+        Fastlane::Helper::Android::LocalizeHelper.download_from_glotpress(
+          res_dir: res_dir,
+          glotpress_project_url: params[:glotpress_url],
+          glotpress_filters: params[:status_filter].map { |s| { status: s } },
+          locales_map: params[:locales]
+        )
+
+        # Update submodules then lint translations
+        unless params[:lint_task].nil? || params[:lint_task].empty?
+          Fastlane::Helper::GitHelper.update_submodules()
+          Action.sh('./gradlew', params[:lint_task])
+        end
+
+        Fastlane::Helper::GitHelper.commit(message: 'Update translations', files: res_dir, push: true) unless params[:skip_commit]
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Download Android string.xml files from GlotPress and lint the updated translations'
+      end
+
+      def self.details
+        'Download translations from GlotPress, update local strings.xml files accordingly, lint, commit the changes, and push to the remote'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :res_dir,
+            env_name: 'FL_DOWNLOAD_TRANSLATIONS_RES_DIR',
+            description: "The path to the Android project's `res` dir (typically the `<project name>/src/main/res` directory) containing the `values-*` subdirs",
+            type: String,
+            default_value: "#{ENV['PROJECT_NAME']}/src/main/res"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :glotpress_url,
+            env_name: 'FL_DOWNLOAD_TRANSLATIONS_GLOTPRESS_URL',
+            description: 'URL to the GlotPress project',
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :status_filter,
+            env_name: 'FL_DOWNLOAD_TRANSLATIONS_STATUS_FILTER',
+            description: 'The GlotPress status(es) to filter on when downloading the translations',
+            type: Array,
+            default_value: 'current'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :source_locale,
+            env_name: 'FL_DOWNLOAD_TRANSLATIONS_SOURCE_LOCALE',
+            description: 'The Android locale code for the source locale (the one serving as original/reference). This will be included into the `available_languages.xml` file',
+            type: String,
+            default_value: 'en_US'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :locales,
+            description: 'An array of hashes – each with the :glotpress and :android keys – listing the locale codes to download and update',
+            type: Array,
+            verify_block: proc do |value|
+              unless value.is_a?(Array) && value.all? { |e| e.is_a?(Hash) && e.key?(:glotpress) && e.key?(:android) }
+                UI.user_error!('The value for the `locales` parameter must be an Array of Hashes, and each Hash must have at least `:glotpress` and `:android` keys.')
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :lint_task,
+            env_name: 'FL_DOWNLOAD_TRANSLATIONS_LINT_TASK',
+            description: 'The name of the Gradle task to run to lint the translations (after this action have updated them). Set to nil or empty string to skip the lint',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :skip_commit,
+            env_name: 'FL_DOWNLOAD_TRANSLATIONS_SKIP_COMMIT',
+            description: 'If set to true, will skip the commit/push step. Otherwise, it will commit the changes and push them (the default)',
+            is_string: false, # Boolean
+            default_value: false
+          ),
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ['AliSoftware']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      ANDROID_FINALIZE_PRECHECKS_CUSTOM_VALUE = :ANDROID_FINALIZE_PRECHECKS_CUSTOM_VALUE
+    end
+
+    class AndroidFinalizePrechecksAction < Action
+      def self.run(params)
+        UI.message "Skip confirm: #{params[:skip_confirm]}"
+
+        require_relative '../../helper/android/android_version_helper.rb'
+        require_relative '../../helper/android/android_git_helper.rb'
+
+        UI.user_error!('This is not a release branch. Abort.') unless other_action.git_branch.start_with?('release/')
+
+        version = Fastlane::Helper::Android::VersionHelper.get_public_version
+        message = "Finalizing release: #{version}\n"
+        if !params[:skip_confirm]
+          UI.user_error!('Aborted by user request') unless UI.confirm("#{message}Do you want to continue?")
+        else
+          UI.message(message)
+        end
+
+        # Check local repo status
+        other_action.ensure_git_status_clean()
+
+        version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Runs some prechecks before finalizing a release'
+      end
+
+      def self.details
+        'Runs some prechecks before finalizing a release'
+      end
+
+      def self.available_options
+        # Define all options your action supports.
+
+        # Below a few examples
+        [
+          FastlaneCore::ConfigItem.new(key: :skip_confirm,
+                                       env_name: 'FL_ANDROID_FINALIZE_PRECHECKS_SKIPCONFIRM',
+                                       description: 'Skips confirmation',
+                                       is_string: false, # true: verifies the input is a string, false: every kind of value
+                                       default_value: false), # the default value if the user didn't provide one
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+        'The current app version'
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fastlane
+  module Actions
+    class AndroidGetAlphaVersionAction < Action
+      def self.run(params)
+        require_relative '../../helper/android/android_version_helper.rb'
+        Fastlane::Helper::Android::VersionHelper.get_alpha_version()
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Gets the alpha version of the app'
+      end
+
+      def self.details
+        'Gets the alpha version of the app'
+      end
+
+      def self.available_options
+        # Define all options your action supports.
+      end
+
+      def self.output
+        # Define the shared values you are going to provide
+      end
+
+      def self.return_value
+        # If you method provides a return value, you can describe here what it does
+        'Return the alpha version of the app'
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fastlane
+  module Actions
+    class AndroidGetAppVersionAction < Action
+      def self.run(params)
+        require_relative '../../helper/android/android_version_helper.rb'
+        Fastlane::Helper::Android::VersionHelper.get_public_version
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Gets the public version of the app'
+      end
+
+      def self.details
+        'Gets the public version of the app'
+      end
+
+      def self.available_options
+        # Define all options your action supports.
+      end
+
+      def self.output
+        # Define the shared values you are going to provide
+      end
+
+      def self.return_value
+        # If you method provides a return value, you can describe here what it does
+        'Return the public version of the app'
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end