wordpress-mobile · spencertransier · Apr 27, 2023 · Apr 26, 2023 · Apr 26, 2023 · Apr 26, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,6 +25,7 @@ _None_
 - Update `danger` to `9.3.0`. This is an internal-only change and is not a breaking change for clients. [#464]
 - Replace `rspec-buildkite-analytics` with `buildkite-test_collector` (Buildkite renamed the gem) and update it to `2.2.0`. This is another internal-only change and is not a breaking change for clients. [#465]
 - Adds `ignore_pipeline_branch_filters=true` parameter to the API call triggering a Buildkite build [#468]
+- Replace all instances of `is_string` with `type` [#469]
 
 ## 7.0.0
 

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -413,7 +413,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  buildkite-test_collector (~> 2.1)
+  buildkite-test_collector (~> 2.2)
   bundler (~> 2.0)
   cocoapods (~> 1.10)
   codecov

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_update_metadata_source_action.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_update_metadata_source_action.rb
@@ -131,7 +131,7 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :po_file_path,
                                        env_name: 'FL_UPDATE_METADATA_SOURCE_PO_FILE_PATH',
                                        description: 'The path of the .po file to update',
-                                       is_string: true,
+                                       type: String,
                                        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)
@@ -145,7 +145,7 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :source_files,
                                        env_name: 'FL_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,
+                                       type: Hash,
                                        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),

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_validate_lib_strings_action.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_validate_lib_strings_action.rb
@@ -33,25 +33,37 @@ def self.return_value
       end
 
       def self.details
-        'Checks that the strings to be localised are updated from the libs into the main application file'
+        <<~DETAILS
+          Checks that the strings to be localised are updated from the libs into the main application file
+
+          For the `lib_strings_path` ConfigItem, it is an array of Hashes, each describing a library and
+          containing these specific keys:
+            - `:library`: The human readable name of the library, used to display in console messages
+            - `:strings_path`: The path to the strings.xml file of the library to merge into the main one
+            - `:exclusions`: An array of strings keys to exclude during merge. Any of those keys from the
+               library's `strings.xml` will be skipped and won't be merged into the main one.
+            - `:source_id`: An optional `String` which will be added as the `a8c-src-lib` XML attribute
+               to strings coming from this library, to help identify their source in the merged file.
+            - `:add_ignore_attr`: If set to `true`, will add `tools:ignore="UnusedResources"` to merged strings.
+        DETAILS
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :app_strings_path,
                                        description: 'The path of the main strings file',
                                        optional: false,
-                                       is_string: true),
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :libs_strings_path,
                                        env_name: 'CHECK_LIBS_STRINGS_PATH',
-                                       description: 'The list of libs to merge',
+                                       description: 'The list of libs to merge. This should be an array of Hashes.',
                                        optional: false,
-                                       is_string: false),
+                                       type: Array),
           FastlaneCore::ConfigItem.new(key: :diff_url,
                                        env_name: 'CHECK_LIBS_DIFF_URL',
                                        description: 'The url of the diff to check',
                                        optional: true,
-                                       is_string: true),
+                                       type: String),
         ]
       end
 

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_betabuild_prechecks.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_betabuild_prechecks.rb
@@ -74,12 +74,12 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :base_version,
                                        env_name: 'FL_ANDROID_BETABUILD_PRECHECKS_BASE_VERSION',
                                        description: 'The version to work on', # a short description of this parameter
-                                       is_string: true,
+                                       type: String,
                                        optional: true), # true: verifies the input is a string, false: every kind of value),
           FastlaneCore::ConfigItem.new(key: :skip_confirm,
                                        env_name: 'FL_ANDROID_BETABUILD_PRECHECKS_SKIPCONFIRM',
                                        description: 'Skips confirmation',
-                                       is_string: false, # true: verifies the input is a string, false: every kind of value
+                                       type: Boolean,
                                        default_value: false), # the default value if the user didn't provide one
           FastlaneCore::ConfigItem.new(key: :default_branch,
                                        env_name: 'FL_RELEASE_TOOLKIT_DEFAULT_BRANCH',

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_build_prechecks.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_build_prechecks.rb
@@ -46,22 +46,22 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :skip_confirm,
                                        env_name: 'FL_ANDROID_BUILD_PRECHECKS_SKIP_CONFIRM',
                                        description: 'True to avoid the system ask for confirmation',
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
           FastlaneCore::ConfigItem.new(key: :alpha,
                                        env_name: 'FL_ANDROID_BUILD_PRECHECKS_ALPHA_BUILD',
                                        description: 'True if this is for an alpha build',
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
           FastlaneCore::ConfigItem.new(key: :beta,
                                        env_name: 'FL_ANDROID_BUILD_PRECHECKS_BETA_BUILD',
                                        description: 'True if this is for a beta build',
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
           FastlaneCore::ConfigItem.new(key: :final,
                                        env_name: 'FL_ANDROID_BUILD_PRECHECKS_FINAL_BUILD',
                                        description: 'True if this is for a final build',
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
         ]
       end

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_bump_version_hotfix.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_bump_version_hotfix.rb
@@ -43,14 +43,14 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :version_name,
                                        env_name: 'FL_ANDROID_BUMP_VERSION_HOTFIX_VERSION',
                                        description: 'The version name for the hotfix',
-                                       is_string: true),
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :version_code,
                                        env_name: 'FL_ANDROID_BUMP_VERSION_HOTFIX_CODE',
                                        description: 'The version code for the hotfix'),
           FastlaneCore::ConfigItem.new(key: :previous_version_name,
                                        env_name: 'FL_ANDROID_BUMP_VERSION_HOTFIX_PREVIOUS_VERSION',
                                        description: 'The version to branch from',
-                                       is_string: true),
+                                       type: String),
         ]
       end
 

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_codefreeze_prechecks.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_codefreeze_prechecks.rb
@@ -57,7 +57,7 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :skip_confirm,
                                        env_name: 'FL_ANDROID_CODEFREEZE_PRECHECKS_SKIPCONFIRM',
                                        description: 'Skips confirmation before codefreeze',
-                                       is_string: false, # true: verifies the input is a string, false: every kind of value
+                                       type: Boolean,
                                        default_value: false), # the default value if the user didn't provide one
           FastlaneCore::ConfigItem.new(key: :default_branch,
                                        env_name: 'FL_RELEASE_TOOLKIT_DEFAULT_BRANCH',

diff --git a/...fastlane/plugin/wpmreleasetoolkit/actions/android/android_completecodefreeze_prechecks.rb b/...fastlane/plugin/wpmreleasetoolkit/actions/android/android_completecodefreeze_prechecks.rb
@@ -40,7 +40,7 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :skip_confirm,
                                        env_name: 'FL_ANDROID_COMPLETECODEFREEZE_PRECHECKS_SKIPCONFIRM',
                                        description: 'Skips confirmation',
-                                       is_string: false, # true: verifies the input is a string, false: every kind of value
+                                       type: Boolean,
                                        default_value: false), # the default value if the user didn't provide one
         ]
       end

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_create_xml_release_notes.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_create_xml_release_notes.rb
@@ -38,16 +38,16 @@ def self.available_options
                                        env_name: 'ANDROID_XML_NOTES_DOWNLOAD_PATH',
                                        description: 'The path to the folder with the release notes',
                                        optional: false,
-                                       is_string: true),
+                                       type: String),
           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),
+                                       type: String),
           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),
+                                       type: Hash),
         ]
       end
 

diff --git a/...fastlane/plugin/wpmreleasetoolkit/actions/android/android_download_translations_action.rb b/...fastlane/plugin/wpmreleasetoolkit/actions/android/android_download_translations_action.rb
@@ -91,7 +91,7 @@ def self.available_options
             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
+            type: Boolean,
             default_value: false
           ),
         ]

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_finalize_prechecks.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_finalize_prechecks.rb
@@ -47,7 +47,7 @@ def self.available_options
           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
+                                       type: Boolean,
                                        default_value: false), # the default value if the user didn't provide one
         ]
       end

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_hotfix_prechecks.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_hotfix_prechecks.rb
@@ -51,11 +51,11 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :version_name,
                                        env_name: 'FL_ANDROID_HOTFIX_PRECHECKS_VERSION',
                                        description: 'The hotfix version number to create',
-                                       is_string: true),
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :skip_confirm,
                                        env_name: 'FL_ANDROID_HOTFIX_PRECHECKS_SKIPCONFIRM',
                                        description: 'Skips confirmation',
-                                       is_string: false, # Boolean
+                                       type: Boolean,
                                        default_value: false),
         ]
       end

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_tag_build.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_tag_build.rb
@@ -28,7 +28,7 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :tag_alpha,
                                        env_name: 'FL_ANDROID_TAG_BUILD_ALPHA',
                                        description: 'True to skip tagging the alpha version',
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true),
         ]
       end

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_update_release_notes.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_update_release_notes.rb
@@ -34,11 +34,11 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :new_version,
                                        env_name: 'FL_ANDROID_UPDATE_RELEASE_NOTES_VERSION',
                                        description: 'The version we are currently freezing; An empty entry for the _next_ version after this one will be added to the release notes',
-                                       is_string: true),
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :release_notes_file_path,
                                        env_name: 'FL_ANDROID_UPDATE_RELEASE_NOTES_FILE_PATH',
                                        description: 'The path to the release notes file to be updated',
-                                       is_string: true,
+                                       type: String,
                                        default_value: File.join(ENV['PROJECT_ROOT_FOLDER'] || '.', 'RELEASE-NOTES.txt')),
         ]
       end

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/check_for_toolkit_updates_action.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/check_for_toolkit_updates_action.rb
@@ -86,7 +86,7 @@ def self.available_options
           FastlaneCore::ConfigItem.new(key: :skip_update_suggestion,
                                        env_name: 'CHECK_FOR_TOOLKIT_UPDATES_SKIP_UPDATE_SUGGESTION',
                                        description: 'If true, will still check for new versions, but will not ask if you want to run bundle update if an update is found',
-                                       is_string: false, # Boolean
+                                       type: Boolean,
                                        default_value: false),
         ]
       end

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/check_translation_progress.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/check_translation_progress.rb
@@ -125,13 +125,13 @@ def self.available_options
                                        description: 'Should we abort with a global error if any violations are found?',
                                        optional: true,
                                        default_value: true,
-                                       is_string: false),
+                                       type: Boolean),
           FastlaneCore::ConfigItem.new(key: :skip_confirm,
                                        env_name: 'FL_CHECK_TRANSLATION_SKIP_CONFIRM',
                                        description: 'Move ahead without requesting confirmation if violations are found. Only works if "abort_on_violations" is disabled',
                                        optional: true,
                                        default_value: false,
-                                       is_string: false),
+                                       type: Boolean),
         ]
       end
 

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_new_milestone_action.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_new_milestone_action.rb
@@ -62,19 +62,19 @@ def self.available_options
                                        env_name: 'GHHELPER_NEED_APPSTORE_SUBMISSION',
                                        description: 'True if the app needs to be submitted',
                                        optional: true,
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
           FastlaneCore::ConfigItem.new(key: :milestone_duration,
                                        env_name: 'GHHELPER_MILESTONE_DURATION',
                                        description: 'Milestone duration in number of days',
                                        optional: true,
-                                       is_string: false,
+                                       type: Integer,
                                        default_value: 14),
           FastlaneCore::ConfigItem.new(key: :number_of_days_from_code_freeze_to_release,
                                        env_name: 'GHHELPER_NUMBER_OF_DAYS_FROM_CODE_FREEZE_TO_RELEASE',
                                        description: 'Number of days from code freeze to release',
                                        optional: true,
-                                       is_string: false,
+                                       type: Integer,
                                        default_value: 14),
           Fastlane::Helper::GithubHelper.github_token_config_item,
         ]

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_release_action.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_release_action.rb
@@ -84,7 +84,7 @@ def self.available_options
                                        description: 'True if this is a pre-release',
                                        optional: true,
                                        default_value: false,
-                                       is_string: false),
+                                       type: Boolean),
           FastlaneCore::ConfigItem.new(key: :is_draft,
                                        env_name: 'GHHELPER_CREATE_RELEASE_IS_DRAFT',
                                        description: 'True to create the GitHub release as a draft (instead of publishing it immediately)',

diff --git a/...tlane/plugin/wpmreleasetoolkit/actions/common/extract_release_notes_for_version_action.rb b/...tlane/plugin/wpmreleasetoolkit/actions/common/extract_release_notes_for_version_action.rb
@@ -67,17 +67,17 @@ def self.available_options
                                        env_name: 'GHHELPER_EXTRACT_NOTES_VERSION',
                                        description: 'The version of the release',
                                        optional: false,
-                                       is_string: true),
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :release_notes_file_path,
                                        env_name: 'GHHELPER_EXTRACT_NOTES_FILE_PATH',
                                        description: 'The path to the file that contains the release notes',
                                        optional: false,
-                                       is_string: true),
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :extracted_notes_file_path,
                                        env_name: 'GHHELPER_EXTRACT_NOTES_EXTRACTED_FILE_PATH',
                                        description: 'The path to the file that will contain the extracted release notes',
                                        optional: true,
-                                       is_string: true),
+                                       type: String),
         ]
       end