fastlane-plugin-translate_gpt_release_notes 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 583516edebe47c16ac07d08fad7c985ba813ee714465248654dd5dd029bd1d5b
-  data.tar.gz: 55366af37fecbdf65d587dc31464c5a9b0be8779a819261214f99c7d5affb286
+  metadata.gz: 34d44bece5c1bdb823c405512f9cd7123c61584c7839d832eeae0f3b8c730d3f
+  data.tar.gz: '0851f02c45a3fcce10a4313fbb6a55f4334f770fc0aa78fdf4a98b0d2fc25fb8'
 SHA512:
-  metadata.gz: c2db228382b529fa334385d97c39e1daecbd7280894f2aa0b9b870d2a8a1027c15eee79c6253b7c2d07cd0bc228ff684d77a892eaa954842fcc8e03befef0f8e
-  data.tar.gz: 25021f03188ebbb7551ed18c5da99cce25568ba46e6c92f1c1160207997414ded93b4cbed993f10b30f7eebc1004ced57ae36fbaca6769acfe39638ad10bcb31
+  metadata.gz: 3572a763d2202c00cb26e826f44b141e1d4042ea33214fd6182c3f2dcb6d672b0d36625c42f8ccc454a406460d49f04efeff391bde9e8c12affe73f33676c606
+  data.tar.gz: 52a36475a11bb478ba51f8823916649272a4bd7e3fb42113a5462b2f5dd58051df34dee849460de3c40859a97e0712f8f30f47e579cf30017cfe7a3903075871

data/README.md

@@ -182,7 +182,8 @@ The glossary feature ensures consistent translation of app-specific terms (scree
 1. The plugin loads glossary terms from a JSON file and/or a directory of localization files
 2. Before each translation, it fuzzy-matches terms from the glossary against the source text
 3. Only relevant terms are included in the translation prompt (keeping it concise)
-4. Each provider uses the glossary differently:
+4. The AI is instructed to use glossary terms as **reference translations** and apply appropriate grammatical forms (declension, conjugation, agreement) as needed — so translations sound natural in inflected languages like Russian, German, or Finnish rather than copying terms verbatim
+5. Each provider uses the glossary differently:
    - **OpenAI**: Glossary terms are sent as a system message for strong instruction following
    - **Anthropic / Gemini**: Glossary terms are included in the translation prompt
    - **DeepL**: Glossary terms are passed via the `context` parameter
@@ -406,10 +407,10 @@ translate_gpt_release_notes(
 
 ### Android 500 Character Limit
 
-Android has a limit of 500 characters for changelogs. The plugin handles this in two ways:
+Android has a hard limit of 500 characters for changelogs. The plugin enforces this in two layers:
 
-1. **AI Providers (OpenAI, Anthropic, Gemini)**: The character limit is included in the translation prompt, asking the AI to stay within the limit
-2. **DeepL**: Translations are truncated to 500 characters with a warning if they exceed the limit
+1. **Prompt constraint**: For AI providers, the limit is included near the top of the prompt (alongside core instructions) with explicit wording that the model must count carefully and shorten or summarize if needed. This positions it as a hard constraint rather than an afterthought.
+2. **Safety-net truncation**: All providers (including DeepL) truncate the result and log a warning if the model still exceeds 500 characters despite the prompt.
 
 If you frequently hit the limit, consider shortening your master locale changelog.
 
@@ -465,9 +466,9 @@ export OPENAI_API_KEY='your-key-here'
 **Cause**: The translated text is longer than 500 characters.
 
 **Solutions**:
-1. Shorten your source changelog
-2. For DeepL, translations are automatically truncated
-3. For AI providers, the prompt includes the limit but compliance isn't guaranteed
+1. Shorten your source changelog — the most reliable fix
+2. All providers will truncate automatically if the limit is exceeded (with a warning), but this may cut mid-sentence
+3. For AI providers, the prompt strongly instructs the model to stay within the limit and shorten if needed
 
 ### API Timeout Errors
 

data/lib/fastlane/plugin/translate_gpt_release_notes/helper/providers/anthropic_provider.rb

@@ -83,10 +83,11 @@ module Fastlane
         # @return [String, nil] Translated text or nil on error
         def translate(text, source_locale, target_locale, glossary_terms: {})
           # Build prompt using inherited method (includes instructions, glossary, and text)
-          prompt = build_prompt(text, source_locale, target_locale, glossary_terms: glossary_terms)
-
-          # Add Android limitations if needed (appended after the text)
-          prompt += "\n\n" + android_limitation_instruction if @params[:platform] == 'android'
+          prompt = build_prompt(
+            text, source_locale, target_locale,
+            glossary_terms: glossary_terms,
+            platform: @params[:platform]
+          )
 
           # Make API call using ruby-anthropic gem API
           response = @client.complete(
@@ -97,7 +98,7 @@ module Fastlane
           )
 
           # Extract text from response
-          extract_text_from_response(response)
+          enforce_android_limit(extract_text_from_response(response))
         rescue StandardError => e
           UI.error "Anthropic provider error: #{e.message}"
           nil

data/lib/fastlane/plugin/translate_gpt_release_notes/helper/providers/base_provider.rb

@@ -92,13 +92,19 @@ module Fastlane
         # @param target_locale [String] Target language code
         # @param glossary_terms [Hash] Optional glossary { source_term => target_translation }
         # @return [String] The formatted prompt
-        def build_prompt(text, source_locale, target_locale, glossary_terms: {})
+        def build_prompt(text, source_locale, target_locale, glossary_terms: {}, platform: nil)
           prompt_parts = []
 
           # Instructions first: role, task, and output format
           prompt_parts << "Translate the following release notes from #{source_locale} to #{target_locale}."
           prompt_parts << "Respond with ONLY the translated text. Preserve the original formatting, line breaks, and bullet points."
 
+          # Android character limit is a hard constraint — include it with core instructions
+          if platform == 'android'
+            prompt_parts << ""
+            prompt_parts << android_limitation_instruction
+          end
+
           # Add context if provided
           if @params[:context]
             prompt_parts << ""
@@ -108,7 +114,7 @@ module Fastlane
           # Add glossary terms before the text so the model reads them first
           unless glossary_terms.nil? || glossary_terms.empty?
             prompt_parts << ""
-            prompt_parts << "Use the following glossary for consistent terminology. Apply these exact translations for the specified terms:"
+            prompt_parts << "Use the following glossary for consistent terminology. These are reference translations — apply appropriate grammatical forms (declension, conjugation, agreement) as needed for natural-sounding language in the target language. Do not copy verbatim if grammar requires a different form:"
             glossary_terms.each do |source_term, target_term|
               prompt_parts << "- \"#{source_term}\" -> \"#{target_term}\""
             end
@@ -130,12 +136,18 @@ module Fastlane
         # @param target_locale [String] Target language code
         # @param glossary_terms [Hash] Optional glossary { source_term => target_translation }
         # @return [String] The system instruction
-        def build_system_instruction(source_locale, target_locale, glossary_terms: {})
+        def build_system_instruction(source_locale, target_locale, glossary_terms: {}, platform: nil)
           parts = []
 
           parts << "Translate the following release notes from #{source_locale} to #{target_locale}."
           parts << "Respond with ONLY the translated text. Preserve the original formatting, line breaks, and bullet points."
 
+          # Android character limit is a hard constraint — include it with core instructions
+          if platform == 'android'
+            parts << ""
+            parts << android_limitation_instruction
+          end
+
           if @params[:context]
             parts << ""
             parts << "Context: #{@params[:context]}"
@@ -143,7 +155,7 @@ module Fastlane
 
           unless glossary_terms.nil? || glossary_terms.empty?
             parts << ""
-            parts << "Use the following glossary for consistent terminology. Apply these exact translations for the specified terms:"
+            parts << "Use the following glossary for consistent terminology. These are reference translations — apply appropriate grammatical forms (declension, conjugation, agreement) as needed for natural-sounding language in the target language. Do not copy verbatim if grammar requires a different form:"
             glossary_terms.each do |source_term, target_term|
               parts << "- \"#{source_term}\" -> \"#{target_term}\""
             end
@@ -157,17 +169,21 @@ module Fastlane
         #
         # @return [String] The Android limitation instruction
         def android_limitation_instruction
-          "IMPORTANT: The translated text must not exceed #{ANDROID_CHAR_LIMIT} characters " \
-          "(Google Play Store release notes limit). Provide a concise translation."
+          "CRITICAL: Google Play Store enforces a hard #{ANDROID_CHAR_LIMIT}-character limit for release notes. " \
+          "Your translation MUST be #{ANDROID_CHAR_LIMIT} characters or fewer. " \
+          "Count carefully and shorten or summarize if needed to stay within this limit."
         end
 
-        # Adds Android character limit constraint to the prompt.
-        # Google Play has a 500 character limit for release notes.
+        # Truncates the translated text to the Android character limit if exceeded.
+        # Logs a warning when truncation occurs.
         #
-        # @param prompt [String] The existing prompt to append to
-        # @return [String] The prompt with limitation instruction appended
-        def apply_android_limitations(prompt)
-          prompt + android_limitation_instruction
+        # @param text [String, nil] The translated text
+        # @return [String, nil] The text, truncated to ANDROID_CHAR_LIMIT if necessary
+        def enforce_android_limit(text)
+          return text unless @params[:platform] == 'android' && text && text.length > ANDROID_CHAR_LIMIT
+
+          UI.warning("Translation exceeds #{ANDROID_CHAR_LIMIT} characters (#{text.length}), truncating...")
+          text[0...ANDROID_CHAR_LIMIT]
         end
 
         # Adds a configuration error to the errors list.

data/lib/fastlane/plugin/translate_gpt_release_notes/helper/providers/deepl_provider.rb

@@ -118,15 +118,7 @@ module Fastlane
           # Make API call
           result = DeepL.translate(text, source_lang, target_lang, options)
 
-          translated = result.text
-
-          # Handle Android 500 character limit
-          if @params[:platform] == 'android' && translated.length > 500
-            UI.warning "DeepL translation exceeds 500 characters (#{translated.length}), truncating..."
-            translated = translated[0...500]
-          end
-
-          translated
+          enforce_android_limit(result.text)
         rescue DeepL::Exceptions::RequestError => e
           UI.error "DeepL API error: #{e.message}"
           nil

data/lib/fastlane/plugin/translate_gpt_release_notes/helper/providers/gemini_provider.rb

@@ -80,16 +80,17 @@ module Fastlane
         # @return [String, nil] Translated text or nil on error
         def translate(text, source_locale, target_locale, glossary_terms: {})
           # Build prompt using inherited method (includes instructions, glossary, and text)
-          prompt = build_prompt(text, source_locale, target_locale, glossary_terms: glossary_terms)
-
-          # Add Android limitations if needed (appended after the text)
-          prompt += "\n\n" + android_limitation_instruction if @params[:platform] == 'android'
+          prompt = build_prompt(
+            text, source_locale, target_locale,
+            glossary_terms: glossary_terms,
+            platform: @params[:platform]
+          )
 
           # Make API call
           result = make_api_request(prompt)
 
           # Extract text from response
-          extract_text_from_response(result)
+          enforce_android_limit(extract_text_from_response(result))
         rescue StandardError => e
           UI.error "Gemini provider error: #{e.message}"
           nil

data/lib/fastlane/plugin/translate_gpt_release_notes/helper/providers/openai_provider.rb

@@ -82,14 +82,13 @@ module Fastlane
         # @return [String, nil] Translated text or nil on error
         def translate(text, source_locale, target_locale, glossary_terms: {})
           # Build system instruction and user content separately for better results
-          system_instruction = build_system_instruction(source_locale, target_locale, glossary_terms: glossary_terms)
+          system_instruction = build_system_instruction(
+            source_locale, target_locale,
+            glossary_terms: glossary_terms,
+            platform: @params[:platform]
+          )
           user_content = text
 
-          # Add Android limitations to system instruction if needed
-          if @params[:platform] == 'android'
-            system_instruction += "\n\n" + android_limitation_instruction
-          end
-
           # Build parameters hash with separate system and user messages
           parameters = {
             model: @params[:model_name] || DEFAULT_MODEL,
@@ -112,7 +111,7 @@ module Fastlane
             UI.error "OpenAI translation error: #{error}"
             nil
           else
-            response.dig('choices', 0, 'message', 'content')&.strip
+            enforce_android_limit(response.dig('choices', 0, 'message', 'content')&.strip)
           end
         rescue StandardError => e
           UI.error "OpenAI provider error: #{e.message}"

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TranslateGptReleaseNotes
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-translate_gpt_release_notes
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Anton Karliner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-12 00:00:00.000000000 Z
+date: 2026-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai