fastlane-plugin-translate_gpt_release_notes 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34d44bece5c1bdb823c405512f9cd7123c61584c7839d832eeae0f3b8c730d3f
-  data.tar.gz: '0851f02c45a3fcce10a4313fbb6a55f4334f770fc0aa78fdf4a98b0d2fc25fb8'
+  metadata.gz: 8b804e528e753243e44795157932c4d7fe91dd86f7393fc3c27169bd46ae064a
+  data.tar.gz: 46dcb053c8eca62129b0616477a4f0b7287c63dd40de91f40749f35b04758f70
 SHA512:
-  metadata.gz: 3572a763d2202c00cb26e826f44b141e1d4042ea33214fd6182c3f2dcb6d672b0d36625c42f8ccc454a406460d49f04efeff391bde9e8c12affe73f33676c606
-  data.tar.gz: 52a36475a11bb478ba51f8823916649272a4bd7e3fb42113a5462b2f5dd58051df34dee849460de3c40859a97e0712f8f30f47e579cf30017cfe7a3903075871
+  metadata.gz: 3942636066fa49fb840cb6855742b3605e71894b6ce40b235bb25c96d49282da9a7bde5ca458f32b13bb9ac015f74a05efd2995ef7c73ed6119a43aa75a7eab9
+  data.tar.gz: f37538e795cfb574c2c7a5a3a025dc4ef9d78b228e27cce6636ccb9ef7fd2fd4984c4304424a0af2f1b15f266e1df0307e283b6fe39f8cb7662d41a9c20ba475

data/README.md

@@ -171,6 +171,8 @@ translate_gpt_release_notes(
 
 **Note**: DeepL automatically detects free vs paid API keys (free keys end with `:fx`) and uses the appropriate endpoint.
 
+**Note**: DeepL requires region-qualified targets for English (`EN-US` or `EN-GB`) and Portuguese (`PT-PT` or `PT-BR`). The plugin handles this automatically based on the locale passed — `en` and `en-US` both map to `EN-US`, `en-GB` maps to `EN-GB`, and similarly for Portuguese.
+
 ## Glossary Support (Experimental)
 
 > **Note**: Glossary support is an experimental feature. If you encounter any issues, please [open an issue on GitHub](https://github.com/antonkarliner/fastlane-plugin-translate_gpt_release_notes/issues).
@@ -287,6 +289,7 @@ This keeps the glossary concise and avoids flooding the AI provider with irrelev
 | `context` | Context for translation to improve accuracy | `GPT_CONTEXT` | - |
 | `glossary` | Path to a curated JSON glossary file | `GLOSSARY_PATH` | - |
 | `glossary_dir` | Path to localization files directory for auto-extracting glossary | `GLOSSARY_DIR` | - |
+| `dry_run` | Preview translations and character counts without writing files | `TRANSLATE_DRY_RUN` | `false` |
 
 ### Provider-Specific API Keys
 
@@ -403,6 +406,38 @@ translate_gpt_release_notes(
 )
 ```
 
+## Dry Run
+
+Use `dry_run: true` to call the provider and preview what would be written — without touching any file on disk:
+
+```ruby
+lane :preview_translations do
+  translate_gpt_release_notes(
+    master_locale: 'en-US',
+    platform: 'ios',
+    dry_run: true
+  )
+end
+```
+
+Output looks like:
+
+```
+DRY RUN: no files will be written.
+  fr-FR: 142 chars
+  de-DE: 158 chars
+  ja-JP: 89 chars
+  es-ES: translation FAILED (would be skipped)
+```
+
+For Android, lines exceeding the 500-character limit are flagged:
+
+```
+  de-DE: 523 chars — EXCEEDS 500-char Android limit
+```
+
+No files are written and `last_successful_run.txt` is not updated, so the next real run will still translate.
+
 ## Important Notes
 
 ### Android 500 Character Limit
@@ -426,6 +461,8 @@ All AI translation APIs cost money. Consider these tips:
 - Google Gemini is generally the most cost-effective option
 - DeepL offers competitive pricing for European languages
 - The plugin skips translation if the source file hasn't changed (tracked via `last_successful_run.txt`)
+- If all translations fail, `last_successful_run.txt` is not updated — the next run will retry rather than skip
+- Locales where translation fails are left with their existing file content untouched
 
 ### Service Tiers (OpenAI)
 

data/lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb

@@ -57,10 +57,22 @@ module Fastlane
           translations[locale] = helper.translate_text(master_texts, locale, params[:platform])
         end
 
-        update_translated_texts(base_directory, translated_texts, is_ios, params)
+        if params[:dry_run]
+          print_dry_run_preview(translated_texts, params)
+        else
+          update_translated_texts(base_directory, translated_texts, is_ios, params)
 
-        # Store the current time as the last run time
-        File.write(last_run_file, Time.now.to_i)
+          # Only mark the run successful if at least one translation actually succeeded;
+          # otherwise a transient failure would suppress the next run's retry.
+          any_success = translated_texts.any? do |locale, text|
+            locale != params[:master_locale] && !translation_empty?(text)
+          end
+          if any_success
+            File.write(last_run_file, Time.now.to_i)
+          else
+            UI.error("No translations succeeded; not updating #{last_run_file} so the next run will retry.")
+          end
+        end
       end
 
       def self.list_locales(base_directory)
@@ -93,17 +105,47 @@ module Fastlane
         Dir[File.join(directory, '*.txt')].max_by { |f| File.basename(f, '.txt').to_i }.split('/').last
       end      
 
+      def self.translation_empty?(text)
+        text.nil? || text.to_s.strip.empty?
+      end
+
+      def self.print_dry_run_preview(translated_texts, params)
+        android_limit = 500 # Google Play hard limit; see BaseProvider::ANDROID_CHAR_LIMIT
+        UI.important('DRY RUN: no files will be written.')
+        translated_texts.each do |locale, text|
+          next if locale == params[:master_locale]
+
+          print_locale_preview(locale, text, android_limit, params[:platform])
+        end
+      end
+
+      def self.print_locale_preview(locale, text, android_limit, platform)
+        if text.nil? || text.to_s.strip.empty?
+          UI.warning("  #{locale}: translation FAILED (would be skipped)")
+          return
+        end
+        length = text.length
+        over = platform == 'android' && length > android_limit
+        suffix = over ? " — EXCEEDS #{android_limit}-char Android limit" : ''
+        UI.message("  #{locale}: #{length} chars#{suffix}")
+      end
+
       def self.update_translated_texts(base_directory, translated_texts, is_ios, params)
         translated_texts.each do |locale, text|
           next if locale == params[:master_locale]  # Skip master locale
-      
+
+          if translation_empty?(text)
+            UI.warning("Skipping #{locale}: translation failed or returned empty; existing file left unchanged.")
+            next
+          end
+
           target_path = is_ios ? File.join(base_directory, locale) : File.join(base_directory, locale, 'changelogs')
-      
+
           # Ensure target path exists or create it
           FileUtils.mkdir_p(target_path) unless Dir.exist?(target_path)
-      
+
           filename = is_ios ? 'release_notes.txt' : highest_numbered_file(File.join(base_directory, params[:master_locale], 'changelogs'))
-      
+
           # Write the translated text to the file
           File.write(File.join(target_path, filename), text)
         end
@@ -249,6 +291,14 @@ module Fastlane
               next if value.nil? || value.to_s.strip.empty?
               UI.user_error!("Glossary directory not found: #{value}") unless Dir.exist?(value)
             end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :dry_run,
+            env_name: 'TRANSLATE_DRY_RUN',
+            description: 'Preview translations without writing files',
+            type: Boolean,
+            optional: true,
+            default_value: false
           )
         ]
       end

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

@@ -82,22 +82,12 @@ module Fastlane
         # @param glossary_terms [Hash] Optional glossary { source_term => target_translation }
         # @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,
+          system_instruction = build_system_instruction(
+            source_locale, target_locale,
             glossary_terms: glossary_terms,
             platform: @params[:platform]
           )
-
-          # Make API call using ruby-anthropic gem API
-          response = @client.complete(
-            model: @params[:model_name] || DEFAULT_MODEL,
-            max_tokens_to_sample: (@params[:max_tokens] || DEFAULT_MAX_TOKENS).to_i,
-            temperature: (@params[:temperature] || DEFAULT_TEMPERATURE).to_f,
-            prompt: "\n\nHuman: #{prompt}\n\nAssistant:"
-          )
-
-          # Extract text from response
+          response = @client.messages.create(build_create_params(system_instruction, text))
           enforce_android_limit(extract_text_from_response(response))
         rescue StandardError => e
           UI.error "Anthropic provider error: #{e.message}"
@@ -106,14 +96,22 @@ module Fastlane
 
         private
 
-        # Extracts translated text from the Anthropic API response
-        #
-        # @param response [Hash] The API response hash
-        # @return [String, nil] The translated text or nil
+        def build_create_params(system_instruction, text)
+          {
+            model: @params[:model_name] || DEFAULT_MODEL,
+            max_tokens: (@params[:max_tokens] || DEFAULT_MAX_TOKENS).to_i,
+            temperature: (@params[:temperature] || DEFAULT_TEMPERATURE).to_f,
+            system_: system_instruction,
+            messages: [{ role: 'user', content: text }]
+          }
+        end
+
         def extract_text_from_response(response)
-          return nil if response.nil?
+          content = response&.content
+          return nil if content.to_a.empty?
 
-          response['completion']&.strip
+          text = content.filter_map { |b| b.text if b.type == :text }.join.strip
+          text.empty? ? nil : text
         end
       end
     end

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

@@ -92,10 +92,8 @@ module Fastlane
         # @param glossary_terms [Hash] Optional glossary { source_term => target_translation }
         # @return [String, nil] Translated text or nil on error
         def translate(text, source_locale, target_locale, glossary_terms: {})
-          # DeepL uses ISO 639-1 language codes (2-letter codes)
-          # Convert locales like 'en-US' to 'EN'
-          source_lang = normalize_locale(source_locale)
-          target_lang = normalize_locale(target_locale)
+          source_lang = normalize_source_locale(source_locale)
+          target_lang = normalize_target_locale(target_locale)
 
           # Build options hash
           options = {}
@@ -129,14 +127,26 @@ module Fastlane
 
         private
 
-        # Normalizes locale codes for DeepL API.
-        # DeepL uses 2-letter ISO 639-1 codes (e.g., 'EN', 'DE', 'FR').
-        # Converts 'en-US' → 'EN', 'de-DE' → 'DE'.
-        #
-        # @param locale [String] The locale string to normalize
-        # @return [String] The normalized 2-letter language code
-        def normalize_locale(locale)
-          locale.to_s.split('-').first.upcase
+        # Normalizes a locale for use as the DeepL SOURCE language.
+        # DeepL source accepts only the bare 2-letter ISO 639-1 code.
+        # 'en-US' -> 'EN', 'de-DE' -> 'DE'.
+        def normalize_source_locale(locale)
+          locale.to_s.split(/[-_]/).first.to_s.upcase
+        end
+
+        # Normalizes a locale for use as the DeepL TARGET language.
+        # DeepL requires a region for English ('EN-US'/'EN-GB') and Portuguese
+        # ('PT-PT'/'PT-BR'); bare 'EN'/'PT' are deprecated targets and rejected.
+        # All other targets use the bare 2-letter code.
+        def normalize_target_locale(locale)
+          parts = locale.to_s.split(/[-_]/)
+          lang = parts[0].to_s.downcase
+          region = parts[1].to_s.upcase
+          case lang
+          when 'en' then region == 'GB' ? 'EN-GB' : 'EN-US'
+          when 'pt' then region == 'BR' ? 'PT-BR' : 'PT-PT'
+          else lang.upcase
+          end
         end
       end
     end

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

@@ -57,7 +57,7 @@ module Fastlane
         # @param params [Hash] Configuration parameters for the provider
         def initialize(params)
           super
-          @api_key = params[:api_token]
+          @api_key = credential(:api_token)
           @model = @params[:model_name] || DEFAULT_MODEL
           @temperature = (@params[:temperature] || DEFAULT_TEMPERATURE).to_f
           @timeout = (@params[:request_timeout] || DEFAULT_TIMEOUT).to_i

data/lib/fastlane/plugin/translate_gpt_release_notes/helper/translate_gpt_release_notes_helper.rb

@@ -44,51 +44,6 @@ module Fastlane
         @provider.translate(text, source_locale, target_locale, glossary_terms: glossary_terms)
       end
 
-      # Sleep for a specified number of seconds, displaying a progress bar
-      def wait(seconds = @params[:request_timeout])
-        sleep_time = 0
-        while sleep_time < seconds
-          percent_complete = (sleep_time.to_f / seconds.to_f) * 100.0
-          progress_bar_width = 20
-          completed_width = (progress_bar_width * percent_complete / 100.0).round
-          remaining_width = progress_bar_width - completed_width
-          print "\rTimeout ["
-          print Colorizer::code(:green)
-          print "=" * completed_width
-          print " " * remaining_width
-          print Colorizer::code(:reset)
-          print "]"
-          print " %.2f%%" % percent_complete
-          $stdout.flush
-          sleep(1)
-          sleep_time += 1
-        end
-        print "\r"
-        $stdout.flush
-      end
-    end
-
-    # Helper class for bash colors
-    class Colorizer
-      COLORS = {
-        black:   30,
-        red:     31,
-        green:   32,
-        yellow:  33,
-        blue:    34,
-        magenta: 35,
-        cyan:    36,
-        white:   37,
-        reset:   0,
-      }
-
-      def self.colorize(text, color)
-        color_code = COLORS[color.to_sym]
-        "\e[#{color_code}m#{text}\e[0m"
-      end
-      def self.code(color)
-        "\e[#{COLORS[color.to_sym]}m"
-      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TranslateGptReleaseNotes
-    VERSION = "0.3.2"
+    VERSION = "0.4.0"
   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.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Anton Karliner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-01 00:00:00.000000000 Z
+date: 2026-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: loco_strings
   requirement: !ruby/object:Gem::Requirement