fastlane-plugin-wpmreleasetoolkit 13.3.1 → 13.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ee60c5f0a3e9884bf810f436b0a2480805c7e54aa95ac65f7b38e971ab6340e
-  data.tar.gz: 12718cd798a67c45d3f056f38aa9f69fa6dff65860936fda4d8d20dfba1e2737
+  metadata.gz: d022bdc136add014c305e7d06dee672e4cd9bb34bcac77ccef7a876f54597c9d
+  data.tar.gz: 92bee8e4989223907a6f2e8c8e733219ffba191c49a756e01e60dbbe95a3c913
 SHA512:
-  metadata.gz: befe8e1e789fd36d8c4ddf1501c8bcc9e29d33cbe6c2b1541557f2d9e8c1ceadf1f1806673621643692a9d648eeabe69a7575d5fa01c1bce39645bac1b236715
-  data.tar.gz: 692c4ad19f812174ebca4322610689539c25c1c973ebbb6b788de5c518145209d9f8a635a5552135b9cbe5f35deb319ba3c731c11115def13cf3c40f9317db43
+  metadata.gz: 690c4f8a452cceda096e4dc9f3667e9a2fbb44c67f7377a58ba1267f1aa7753c3403cabc279e6f28cc2d4b9ba4da43162433dd14034f944001e6b4038d164595
+  data.tar.gz: 669a524c570d9704139a297c54469acfdd86c41da83b1e6754b693e98b27afd24805328199cbe8f449d71e10c7588db12df636c8b08bad8bb86da3b1527a832e

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

@@ -15,11 +15,35 @@ module Fastlane
     end
 
     class UploadBuildToAppsCdnAction < Action
+      # See https://github.a8c.com/Automattic/wpcom/blob/trunk/wp-content/lib/a8c/cdn/src/enums/enum-resource-type.php
       RESOURCE_TYPE = 'Build'
+      # These are from the WordPress.com API, not the Apps CDN plugin
       VALID_POST_STATUS = %w[publish draft].freeze
-      VALID_BUILD_TYPES = %w[Alpha Beta Nightly Production Prototype].freeze
-      VALID_PLATFORMS = ['Android', 'iOS', 'Mac - Silicon', 'Mac - Intel', 'Mac - Any', 'Windows'].freeze
-      VALID_INSTALL_TYPES = ['Full Install', 'Update'].freeze
+      # See https://github.a8c.com/Automattic/wpcom/blob/trunk/wp-content/lib/a8c/cdn/src/enums/enum-build-type.php
+      VALID_BUILD_TYPES = %w[
+        Alpha
+        Beta
+        Nightly
+        Production
+        Prototype
+      ].freeze
+      # See https://github.a8c.com/Automattic/wpcom/blob/trunk/wp-content/lib/a8c/cdn/src/enums/enum-platform.php
+      VALID_PLATFORMS = [
+        'Android',
+        'iOS',
+        'Mac - Silicon',
+        'Mac - Intel',
+        'Mac - Any',
+        'Windows',
+        'Microsoft Store',
+      ].freeze
+      # See https://github.a8c.com/Automattic/wpcom/blob/trunk/wp-content/lib/a8c/cdn/src/enums/enum-install-type.php
+      VALID_INSTALL_TYPES = [
+        'Full Install',
+        'Update',
+      ].freeze
+      # See https://github.a8c.com/Automattic/wpcom/blob/trunk/wp-content/lib/a8c/cdn/src/enums/enum-visibility.php
+      VALID_VISIBILITIES = %i[internal external].freeze
 
       def self.run(params)
         UI.message('Uploading build to Apps CDN...')
@@ -179,6 +203,8 @@ module Fastlane
             type: String,
             verify_block: proc do |value|
               UI.user_error!('Product cannot be empty') if value.to_s.empty?
+              # Unlike for other parameters, we don't validate the product value against a list of valid values because we expect this list of
+              # supported products to be updated on the backend from time to time and we don't want to have to update the toolkit every time for it.
             end
           ),
           FastlaneCore::ConfigItem.new(
@@ -228,7 +254,7 @@ module Fastlane
             optional: false,
             type: Symbol,
             verify_block: proc do |value|
-              UI.user_error!('Visibility must be either :internal or :external') unless %i[internal external].include?(value)
+              UI.user_error!("Visibility must be one of: #{VALID_VISIBILITIES.map { "`:#{_1}`" }.join(', ')}") unless VALID_VISIBILITIES.include?(value.to_s.downcase.to_sym)
             end
           ),
           FastlaneCore::ConfigItem.new(

data/lib/fastlane/plugin/wpmreleasetoolkit/models/app_version.rb

@@ -33,6 +33,14 @@ module Fastlane
       def to_s
         "#{@major}.#{@minor}.#{@patch}.#{@build_number}"
       end
+
+      # Returns an array of the version components.
+      #
+      # @return [Array<Integer>] an array of the version components.
+      #
+      def components
+        [@major, @minor, @patch, @build_number]
+      end
     end
   end
 end

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

@@ -2,6 +2,6 @@
 
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '13.3.1'
+    VERSION = '13.5.0'
   end
 end

data/lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/derived_build_code_formatter.rb

@@ -3,13 +3,35 @@
 module Fastlane
   module Wpmreleasetoolkit
     module Versioning
+      # Max total for `*_digits` params, not counting prefix
+      MAX_TOTAL_DIGITS = 8
+      MIN_DIGIT_COUNT = 1
+      MAX_DIGIT_COUNT = 3
+
       # The `DerivedBuildCodeFormatter` class is a specialized build code formatter for derived build codes.
       # It takes in an AppVersion object and derives a build code from it.
       class DerivedBuildCodeFormatter
+        # Initialize the formatter with configurable prefix and digit counts.
+        #
+        # @param [String] prefix The prefix to use for the build code. Must be a single digit (0-9), or empty string / nil.
+        # @param [Integer] major_digits Number of digits for major version. Must be between 1–3. Defaults to 2.
+        # @param [Integer] minor_digits Number of digits for minor version. Must be between 1–3. Defaults to 2.
+        # @param [Integer] patch_digits Number of digits for patch version. Must be between 1–3. Defaults to 2.
+        # @param [Integer] build_digits Number of digits for build number. Must be between 1–3. Defaults to 2.
+        #
+        def initialize(prefix: nil, major_digits: 2, minor_digits: 2, patch_digits: 2, build_digits: 2)
+          validate_prefix!(prefix)
+          @prefix = prefix.to_s
+
+          @digit_counts = [major_digits, minor_digits, patch_digits, build_digits]
+          @digit_counts.each { |d| validate_digit_count!(d) }
+          validate_total_digits!(@digit_counts)
+        end
+
         # Calculate the next derived build code.
         #
-        # This method derives a new build code from the given AppVersion object by concatenating the digit 1,
-        # the major version, the minor version, the patch version, and the build number.
+        # This method derives a new build code from the given AppVersion object by concatenating the configured prefix,
+        # the major version, the minor version, the patch version, and the build number with configurable digit counts.
         #
         # @param [AppVersion] version The AppVersion object to derive the next build code from.
         #
@@ -18,16 +40,76 @@ module Fastlane
         #
         # @return [String] The formatted build code string.
         #
-        def build_code(build_code = nil, version:)
-          format(
-            # 1 is appended to the beginning of the string in case there needs to be additional platforms or
-            # extensions that could then use a different digit prefix such as 2, etc.
-            '1%<major>.2i%<minor>.2i%<patch>.2i%<build_number>.2i',
-            major: version.major,
-            minor: version.minor,
-            patch: version.patch,
-            build_number: version.build_number
-          )
+        def build_code(_build_code = nil, version:)
+          formatted_components = version.components.zip(@digit_counts).map do |value, width|
+            comp = value.to_s.rjust(width, '0')
+            if comp.length > width
+              UI.user_error!("Version component value (#{value}) exceeds maximum allowed width of #{width} characters. " \
+                             "Consider increasing the corresponding `*_digits` parameter of your `#{self.class.name}`")
+            end
+            comp
+          end
+          [@prefix, *formatted_components].join.gsub(/^0+/, '')
+        end
+
+        private
+
+        # Validates that the prefix is a valid single digit (0-9) or empty string.
+        #
+        # @param [String] prefix The prefix to validate
+        #
+        # @raise [StandardError] If the prefix is invalid
+        #
+        def validate_prefix!(prefix)
+          unless prefix.nil? || prefix.is_a?(String) || prefix.is_a?(Integer)
+            UI.user_error!("Prefix must be a string or integer, got: #{prefix.class}")
+          end
+
+          prefix_str = prefix.to_s
+
+          # Allow empty string
+          return if prefix_str.empty?
+
+          # Check if it's longer than 1 character
+          if prefix_str.length > 1
+            UI.user_error!("Prefix must be a single digit or empty string, got: '#{prefix_str}' (length: #{prefix_str.length})")
+          end
+
+          # Check if it's a valid integer
+          return if ('0'..'9').include?(prefix_str)
+
+          UI.user_error!("Prefix must be an integer digit (0-9) or empty string, got: '#{prefix_str}'")
+        end
+
+        # Validates that the digit count is a valid positive integer within reasonable limits.
+        #
+        # @param [Integer] digit_count The digit count to validate
+        #
+        # @raise [StandardError] If the digit count is invalid
+        #
+        def validate_digit_count!(digit_count)
+          # Check if it's an integer
+          unless digit_count.is_a?(Integer)
+            UI.user_error!("Digit count must be an integer, got: #{digit_count.class}")
+          end
+
+          return if digit_count.between?(MIN_DIGIT_COUNT, MAX_DIGIT_COUNT)
+
+          UI.user_error!("Digit count must be between #{MIN_DIGIT_COUNT} and #{MAX_DIGIT_COUNT} digits, got: #{digit_count}")
+        end
+
+        # Validates that the total number of digits (excluding prefix) doesn't exceed the maximum for multiplatform compatibility.
+        #
+        # Since Google Play's max versionCode is ≈ 2_000_000_000, we want to avoid being too close to the limit
+        # as this would then block us from submitting any updates for that app if we reached it.
+        def validate_total_digits!(digits_list)
+          total_digits = digits_list.sum
+
+          # Limit total digits to 8 (excluding prefix)
+          return if total_digits <= MAX_TOTAL_DIGITS
+
+          UI.user_error!("Total digit count (#{total_digits}) exceeds maximum allowed (#{MAX_TOTAL_DIGITS}). " \
+                         "Current config: major(#{digits_list[0]}) + minor(#{digits_list[1]}) + patch(#{digits_list[2]}) + build(#{digits_list[3]}) digits")
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 13.3.1
+  version: 13.5.0
 platform: ruby
 authors:
 - Automattic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-26 00:00:00.000000000 Z
+date: 2025-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport