Merge branch 'trunk' into fix/rubocop-violations

Author: spencertransier

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,4 +5,5 @@
 - [ ] Run `bundle exec rubocop` to test for code style violations and recommendations
 - [ ] Add Unit Tests (aka `specs/*_spec.rb`) if applicable
 - [ ] Run `bundle exec rspec` to run the whole test suite and ensure all your tests pass
-- [ ] Make sure you added an entry in [the `CHANGELOG.md` file](https://github.com/wordpress-mobile/release-toolkit/blob/trunk/CHANGELOG.md#trunk) to describe your changes under the approprioate existing `###` subsection of the existing `## Trunk` section.
+- [ ] Make sure you added an entry in [the `CHANGELOG.md` file](https://github.com/wordpress-mobile/release-toolkit/blob/trunk/CHANGELOG.md#trunk) to describe your changes under the appropriate existing `###` subsection of the existing `## Trunk` section.
+- [ ] If applicable, add an entry in [the `MIGRATION.md` file](https://github.com/wordpress-mobile/release-toolkit/blob/trunk/MIGRATION.md) to describe how the changes will affect the migration from the previous major version and what the clients will need to change and consider.

CHANGELOG.md

@@ -10,13 +10,53 @@ _None_
 
 ### New Features
 
-- Add `ios_get_build_number` action to get the current build number from an `xcconfig` file. [#458]
-
+_None_
 
 ### Bug Fixes
 
 _None_
 
+### Internal Changes
+
+- Updates `octokit` to `6.1.1`, `danger` to `9.3.1` and `buildkite-test_collector` to `2.3.1`. [#491]
+
+## 8.1.0
+
+### New Features
+
+- Adds auto_retry option to `gp_downloadmetadata_action`. [#474]
+
+## 8.0.1
+
+### Bug Fixes
+
+- Revert the `gp_downloadmetadata_action` `locales` item type from `type: Hash` to `is_string: false`. [#478]
+
+## 8.0.0
+
+### Breaking Changes
+
+- Remove git push commands after creating a new commit or branch. [#472] See `MIGRATION.md` for instructions.
+
+## 7.1.2
+
+### Bug Fixes
+
+- Revert the `gp_downloadmetadata_action` `locales` item type from `type: Hash` to `is_string: false`. [#480]
+
+## 7.1.1
+
+### Internal Changes
+
+- Remove `rubygems_mfa_required` from the `gemspec`. [#475]
+
+## 7.1.0
+
+### New Features
+
+- Add `ios_get_build_number` action to get the current build number from an `xcconfig` file. [#458]
+
+
 ### Internal Changes
 
 - Add "Mobile Secrets" to `configure_update` current branch message to clarify which repo it's referring to. [#455]
@@ -26,6 +66,9 @@ _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]
+- Use `git_branch_name_using_HEAD` instead of `git_branch` so that the return value is not modified by environment variables. This has no impact to our current release flow, that's why it's not in "Breaking changes" section. [#463]
+- Deprecate `ios_clear_intermediate_tags` & `ios_final_tag` actions. [#471]
 
 ## 7.0.0
 

Gemfile

@@ -9,4 +9,4 @@ gem 'codecov', require: false
 gem 'webmock', require: false
 gem 'yard'
 
-gem 'buildkite-test_collector', '~> 2.2'
+gem 'buildkite-test_collector', '~> 2.3'

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fastlane-plugin-wpmreleasetoolkit (7.0.0)
+    fastlane-plugin-wpmreleasetoolkit (8.1.0)
       activesupport (>= 6.1.7.1)
       bigdecimal (~> 1.4)
       buildkit (~> 1.5)
@@ -10,7 +10,7 @@ PATH
       git (~> 1.3)
       google-cloud-storage (~> 1.31)
       nokogiri (~> 1.11)
-      octokit (~> 5.6)
+      octokit (~> 6.1)
       parallel (~> 1.14)
       plist (~> 3.1)
       progress_bar (~> 1.3)
@@ -55,7 +55,7 @@ GEM
     bigdecimal (1.4.4)
     buildkit (1.5.0)
       sawyer (>= 0.6)
-    buildkite-test_collector (2.2.0)
+    buildkite-test_collector (2.3.1)
       activesupport (>= 4.2)
     chroma (0.2.0)
     claide (1.1.0)
@@ -112,18 +112,18 @@ GEM
       colored2 (~> 3.1)
     crack (0.4.5)
       rexml
-    danger (9.3.0)
+    danger (9.3.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (>= 0.9.0, < 3.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.13.0)
+      git (~> 1.13)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
-      octokit (~> 5.0)
+      octokit (~> 6.0)
       terminal-table (>= 1, < 4)
     danger-rubocop (0.10.0)
       danger
@@ -160,7 +160,7 @@ GEM
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
-    faraday-http-cache (2.4.1)
+    faraday-http-cache (2.5.0)
       faraday (>= 0.8)
     faraday-httpclient (1.0.1)
     faraday-multipart (1.0.4)
@@ -288,7 +288,7 @@ GEM
     nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    octokit (5.6.1)
+    octokit (6.1.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     open4 (1.3.4)
@@ -413,7 +413,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  buildkite-test_collector (~> 2.1)
+  buildkite-test_collector (~> 2.3)
   bundler (~> 2.0)
   cocoapods (~> 1.10)
   codecov

MIGRATION.md

@@ -0,0 +1,7 @@
+# Migration Instructions for Major Releases
+
+### From `7.0.0` to `8.0.0`
+
+We are no longer pushing to remote after creating a new commit or a branch. That means, developers need to manually push the changes or add push commands in the project's `Fastfile`. Most importantly, we can no longer immediately trigger beta/final builds after creating a new commit because the changes will not be in remote yet. If you want to keep the existing behavior, you'll need to add a push command before these triggers.
+
+For example, in [WordPress-Android's `new_beta_release` lane](https://github.com/wordpress-mobile/WordPress-Android/blob/0c64cb84c256e004473e97d72b4ac6682ebc140b/fastlane/lanes/release.rb#L86), we download translations, bump the beta version and then trigger a new build in CI. After migrating to `8.0.0` of `release-toolkit`, we'll need to add [`push_to_git_remote`](https://docs.fastlane.tools/actions/push_to_git_remote/) command before this trigger to keep the existing behavior.

fastlane-plugin-wpmreleasetoolkit.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'diffy', '~> 3.3'
   spec.add_dependency 'git', '~> 1.3'
   spec.add_dependency 'nokogiri', '~> 1.11' # Needed for AndroidLocalizeHelper
-  spec.add_dependency 'octokit', '~> 5.6'
+  spec.add_dependency 'octokit', '~> 6.1'
   spec.add_dependency 'parallel', '~> 1.14'
   spec.add_dependency 'plist', '~> 3.1'
   spec.add_dependency 'progress_bar', '~> 1.3'
@@ -60,5 +60,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-require_tools', '~> 0.1.2'
   spec.add_development_dependency 'rubocop-rspec', '2.3.0'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
-  spec.metadata['rubygems_mfa_required'] = 'true'
 end

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),

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
 

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',

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