fastlane-plugin-wpmreleasetoolkit 14.11.2 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a1f1e623158a6faef2f63c3376a61d70cdcee25c70ebf91802d0cebdacef0a2
-  data.tar.gz: af2b3f68f2cc761f05a88c676bad63b12b55b44944052e11fe04b210c3421102
+  metadata.gz: d947683766d2a3fddc5ab9ccf7182bc628ca63d839e94ab6633cead85d91fc76
+  data.tar.gz: 3278ec05690d03d229b938b711e8e4ecf59fe2945008672ebc81b7a5edbfe555
 SHA512:
-  metadata.gz: daf03a722ae1f03c8b9883a7552ca75d575ff059233eed51cb9368686bf4007a816ac193f89a4892f9d1d36ab3fe0d51ad8e09dd2ad2d0301144db006b478258
-  data.tar.gz: 9c0edbfe34703dbf6dace3a805dc22f639cbd861d8d8f3615129eca857000ce9d516e159bff6413f45c92e2cff5dfd43c9c35a6fedcaef6369f6158e856d2f38
+  metadata.gz: 5512d2f282436ade2e641cefb4f5e4b3bb5db9a6c857a1d20841cebf45339c4e4e485e994c6094eb3f1a5eb78a284ef5826edaf0712d51c78b012def1f0bed3a
+  data.tar.gz: fa586cd530a3bb5463e3038ae9e057cab05d8166ab9d69aedbc823824f2770e14efc8afb70674fd66a4e6bc5790e6dfe753a9469eecdd6d1a809176bd9c7a4d4

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

@@ -25,6 +25,8 @@ module Fastlane
             config_file_path: config_file_path
           )
         rescue StandardError => e
+          raise if params[:fail_on_error]
+
           error_msg = "❌ Error computing the list of PRs since #{previous_tag || 'last release'}: `#{e.message}`"
           UI.important(error_msg)
           error_msg # Use error message as GitHub Release body to help us be aware of what went wrong.
@@ -102,6 +104,15 @@ module Fastlane
                                                     'See https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuration-options',
                                        optional: true,
                                        type: String),
+          FastlaneCore::ConfigItem.new(key: :fail_on_error,
+                                       description: 'Whether to fail the lane if the changelog cannot be computed. ' \
+                                                    'When `false` (the default), the error message is returned as the changelog itself, ' \
+                                                    'so that it ends up visible in the GitHub Release body. ' \
+                                                    'Set this to `true` if the caller publishes the release only after this action succeeds, ' \
+                                                    'and would rather stop than publish a release whose notes are an error message',
+                                       optional: true,
+                                       default_value: false,
+                                       type: Boolean),
           Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end

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

@@ -15,10 +15,22 @@ module Fastlane
       end
 
       # Set up by loading the .env file with the given name.
+      #
+      # When `mutate_env` is true (the default), values from the .env file are
+      # layered into the process `ENV` using no-override semantics: keys already
+      # set in `ENV` (e.g. by CI) win. This lets fastlane actions that look up
+      # values via `ENV.fetch(...)` for their `default_value:` find them without
+      # the caller having to thread them through explicitly.
+      #
+      # Pass `mutate_env: false` to keep `ENV` pristine — values are still
+      # accessible via `get_required_env!`, but only through this instance.
+      # Useful for tests that want isolation, or for callers that prefer to
+      # control `ENV` themselves.
       def initialize(
         env_file_name:,
         env_file_folder: File.join(Dir.home, '.a8c-apps'),
         example_env_file_path: 'fastlane/example.env',
+        mutate_env: true,
         print_error_lambda: ->(message) { FastlaneCore::UI.user_error!(message) },
         print_warning_lambda: ->(message) { FastlaneCore::UI.important(message) }
       )
@@ -31,10 +43,30 @@ module Fastlane
           @print_warning_lambda.call("Warning: env file not found at #{@env_path}. Environment variables may not be loaded.")
         end
 
-        # Parse rather than load so we don't mutate the global ENV. Each instance
-        # gets its own view, and values from the process environment (e.g. set by
-        # CI) still take precedence — see `env_value`.
-        @loaded_env = File.exist?(@env_path) ? Dotenv.parse(@env_path) : {}
+        unless mutate_env
+          @loaded_env = File.exist?(@env_path) ? Dotenv.parse(@env_path) : {}
+          @mutations = {}
+          return
+        end
+
+        # `load` rather than `parse` so interpolated values (`B=${A}`) resolve
+        # against the process `ENV`; `parse` resolves them against the file's own values.
+        env_before = ENV.to_h
+        @loaded_env = File.exist?(@env_path) ? Dotenv.load(@env_path) : {}
+        # Records the value this instance wrote for each key it added. On restore,
+        # we delete only if `ENV[key]` still matches — if a later caller overwrote
+        # it, their value is left alone.
+        @mutations = ENV.to_h.reject { |key, _| env_before.key?(key) }
+      end
+
+      # Remove from `ENV` any keys this instance added via `mutate_env: true`,
+      # but only if the value is still the one we wrote. Keys that a later
+      # caller has overwritten are left untouched.
+      # Idempotent — calling more than once is safe. Used by `reset!` and
+      # available for callers that want to roll back manually.
+      def restore_env!
+        @mutations.each { |key, value| ENV.delete(key) if ENV[key] == value }
+        @mutations = {}
       end
 
       # Use this instead of getting values from `ENV` directly. It will throw an error if the requested value is missing or empty.
@@ -135,8 +167,10 @@ module Fastlane
         default!.require_env_vars!(*keys)
       end
 
-      # Clears the default instance, useful for test teardown.
+      # Clears the default instance, useful for test teardown. Also rolls back
+      # any `ENV` mutations the default instance performed via `mutate_env`.
       def self.reset!
+        @default&.restore_env!
         @default = nil
       end
 

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

@@ -267,13 +267,13 @@ module Fastlane
       #
       # @param [String] branch_name The name of the remote branch to delete.
       # @param [String] remote_name The name of the remote to delete the branch from. Defaults to 'origin'
-      # @return [Boolean] true if the branch was deleted, false if not (e.g. no such local branch existed in the first place)
+      # @return [Boolean] true if the branch was deleted, false if it did not exist on the remote
       #
       def self.delete_remote_branch_if_exists!(branch_name, remote_name: 'origin')
-        git_repo = Git.open(Dir.pwd)
-        return false unless git_repo.branches.any? { |b| b.remote&.name == remote_name && b.name == branch_name }
+        return false unless branch_exists_on_remote?(branch_name: branch_name, remote_name: remote_name)
 
-        git_repo.push(remote_name, branch_name, delete: true)
+        Git.open(Dir.pwd).push(remote_name, branch_name, delete: true)
+        true
       end
 
       # Checks whether a given path is ignored by Git, relying on Git's `check-ignore` under the hood.

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

@@ -3,6 +3,6 @@
 module Fastlane
   module Wpmreleasetoolkit
     NAME = 'fastlane-plugin-wpmreleasetoolkit'
-    VERSION = '14.11.2'
+    VERSION = '15.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 14.11.2
+  version: 15.0.0
 platform: ruby
 authors:
 - Automattic
@@ -271,7 +271,6 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_localize_libs_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_update_metadata_source_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_validate_lib_strings_action.rb
-- lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_build_preflight.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_create_avd_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_create_xml_release_notes.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_current_branch_is_hotfix.rb
@@ -324,7 +323,6 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_validate_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/add_development_certificates_to_provisioning_profiles.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/add_devices_to_provisioning_profiles.rb
-- lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_build_preflight.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_check_beta_deps.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_download_strings_files_from_glotpress.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_extract_keys_from_strings_files.rb

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

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Fastlane
-  module Actions
-    class AndroidBuildPreflightAction < Action
-      def self.run(params)
-        # Validate mobile configuration secrets
-        other_action.configure_apply
-
-        # Check gems and pods are up to date. This will exit if it fails
-        begin
-          Action.sh('bundle check')
-        rescue StandardError
-          UI.user_error!("You should run 'bundle install' to make sure gems are up to date")
-          raise
-        end
-
-        begin
-          Action.sh('command -v bundletool > /dev/null')
-        rescue StandardError
-          UI.user_error!("bundletool is required to build the APKs. Install it with 'brew install bundletool'")
-          raise
-        end
-      end
-
-      #####################################################
-      # @!group Documentation
-      #####################################################
-
-      def self.description
-        'Clean the environment to ensure a safe build'
-      end
-
-      def self.details
-        'Clean the environment to ensure a safe build'
-      end
-
-      def self.available_options
-      end
-
-      def self.output
-      end
-
-      def self.return_value
-      end
-
-      def self.authors
-        ['Automattic']
-      end
-
-      def self.is_supported?(platform)
-        platform == :android
-      end
-    end
-  end
-end

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

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module Fastlane
-  module Actions
-    class IosBuildPreflightAction < Action
-      def self.run(params)
-        # Validate mobile configuration secrets
-        other_action.configure_apply
-
-        Action.sh("cd .. && rm -rf #{params[:derived_data_path]}")
-
-        # Verify that ImageMagick exists on this machine and can be called from the command-line.
-        # Internal Builds use it to generate the App Icon as part of the build process
-        begin
-          Action.sh('which convert')
-        rescue StandardError
-          UI.user_error!("Couldn't find ImageMagick. Please install it by running `brew install imagemagick`")
-          raise
-        end
-
-        # Verify that Ghostscript exists on this machine and can be called from the command-line.
-        # Internal Builds use it to generate the App Icon as part of the build process
-        begin
-          Action.sh('which gs')
-        rescue StandardError
-          UI.user_error!("Couldn't find Ghostscript. Please install it by running `brew install ghostscript`")
-          raise
-        end
-
-        # Check gems and pods are up to date. This will exit if it fails
-        begin
-          Action.sh('bundle check')
-        rescue StandardError
-          UI.user_error!("You should run 'rake dependencies' to make sure gems are up to date")
-          raise
-        end
-
-        other_action.cocoapods
-      end
-
-      #####################################################
-      # @!group Documentation
-      #####################################################
-
-      def self.description
-        'Clean the environment to ensure a safe build'
-      end
-
-      def self.details
-        'Clean the environment to ensure a safe build'
-      end
-
-      def self.available_options
-        [
-          FastlaneCore::ConfigItem.new(
-            key: :derived_data_path,
-            description: "The path to the DerivedData directory for the project. Should match what's used in the `gym` action",
-            type: String,
-            default_value: '~/Library/Developer/Xcode/DerivedData'
-          ),
-        ]
-      end
-
-      def self.output
-      end
-
-      def self.return_value
-      end
-
-      def self.authors
-        ['Automattic']
-      end
-
-      def self.is_supported?(platform)
-        %i[ios mac].include?(platform)
-      end
-    end
-  end
-end