fastlane-plugin-translate_gpt_release_notes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acf57fd59e42c6a303f3351aa8b77e3b0218f1cdee9182651c93b60d88919cf5
+  data.tar.gz: cf64458515ae18c2f4df33cd10eb6105aa258bb3e5a3b72c653397e3de4a5325
+SHA512:
+  metadata.gz: 8db4147388d59f649f8eddfdec8fbe099e06243aab5e90f07c8a4b6a860955cb386f09a9151272b8a66863fa179cc632eb321eb909b3b4bb65a87a8db4a1767f
+  data.tar.gz: e1a8558527d3feefdad58fac9e6d165335d1c8e32b8802022da8a25e4be025b5197b8361424bb9a61693ec0a251ee4526e82706240bd9d1258d3b5b47fa30520

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Anton Karliner <anton@karliner.pro>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+![logo](images/logo.png)
+
+# translate-gpt-release-notes plugin
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-translate_gpt`, add it to your project by running:
+
+```bash
+fastlane add_plugin translate_gpt_release_notes
+```
+
+## About translate-gpt-release-notes
+
+`translate-gpt-release-notes` is a fastlane plugin that allows you to translate release notes or changelogs for iOS and Android apps using OpenAI GPT API. Based on [translate-gpt by ftp27](https://github.com/ftp27/fastlane-plugin-translate_gpt).
+
+
+## How it works:
+
+`translate-gpt-release-notes` takes the changelog file for master locale (default: en-US), detects other locales based on fastlane metadata folder structure, translates changelog to all other languages with OpenAI API and creates localized .txt changelong files in respective folders
+
+## Example
+
+The following example demonstrates how to use `translate-gpt-release-notes` in a `Fastfile`
+
+```ruby
+  lane :translate_release_notes do
+    translate_gpt_release_notes(
+      master_locale: 'en-US',
+      platform: 'ios',
+      context: 'This is an app about cute kittens'
+      # other parameters...
+    )
+end
+```
+
+## Options
+
+The following options are available for `translate-gpt-release-notes`:
+
+| Key | Description | Environment Variable |
+| --- | --- | --- |
+| `api_token` | The API key for your OpenAI GPT account. | `GPT_API_KEY` |
+| `model_name` | Name of the ChatGPT model to use (default: gpt-4-1106-preview) | `GPT_MODEL_NAME` |
+| `temperature` | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Defaults to 0.5 | `GPT_TEMPERATURE` |
+| `request_timeout` | Timeout for the request in seconds. Defaults to 30 seconds | `GPT_REQUEST_TIMEOUT` |
+| `master_locale` | Master language/locale for the source texts | `MASTER_LOCALE` |
+| `context` | Context for translation to improve accuracy | `GPT_CONTEXT` |
+| `platform` | Platform for which to translate (ios or android, defaults to ios).| `PLATFORM` |
+
+## Authentication
+
+`translate-gpt-release-notes` supports multiple authentication methods for the OpenAI GPT API:
+
+### API Key
+
+You can provide your API key directly as an option to `translate-gpt`:
+
+```ruby
+translate_gpt_release_notes(
+  api_token: 'YOUR_API_KEY',
+  master_locale: 'en-US',
+  platform: 'ios',
+  context: 'This is an app about cute kittens'
+
+)
+```
+
+### Environment Variable
+
+Alternatively, you can set the `GPT_API_KEY` environment variable with your API key:
+
+```bash
+export GPT_API_KEY='YOUR_API_KEY'
+```
+
+And then call `translate-gp-release-notes` without specifying an API key:
+
+```ruby
+translate_gpt_release_notes(
+  master_locale: 'en-US',
+  platform: 'ios',
+  context: 'This is an app about cute kittens'
+)
+```
+## Important notes:
+
+1. Android has a limit of 500 symbols for changelogs and sometimes translations can exceed this number, which leads to Google API errors when submitting the app. Plugin **tries** to handle this, however errors happen. Reducing the length of master_locale changelog usually helps. iOS has a limit of 4000 symbols, which is plenty.
+2. OpenAI API usage cost money, keep it in mind.
+
+## Issues and Feedback
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide. For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+
+## Contributing
+
+If you'd like to contribute to this plugin, please fork the repository and make your changes. When you're ready, submit a pull request explaining your changes.
+
+## License
+
+This action is released under the [MIT License](LICENSE).

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

@@ -0,0 +1,156 @@
+require 'fastlane/action'
+require 'openai'
+require_relative '../helper/translate_gpt_release_notes_helper'
+
+module Fastlane
+  module Actions
+    class TranslateGptReleaseNotesAction < Action
+      def self.run(params)
+        # Determine if iOS or Android based on the platform
+        is_ios = params[:platform] == 'ios'
+        base_directory = is_ios ? 'fastlane/metadata' : 'fastlane/metadata/android'
+
+        # Check if the base directory exists before proceeding
+        unless Dir.exist?(base_directory)
+          UI.error("Directory does not exist: #{base_directory}")
+          return
+        end
+
+        locales = list_locales(base_directory)
+        master_texts = fetch_master_texts(base_directory, params[:master_locale], is_ios)
+
+        helper = Helper::TranslateGptReleaseNotesHelper.new(params)
+        translated_texts = locales.each_with_object({}) do |locale, translations|
+          next if locale == params[:master_locale]  # Skip master locale
+          translations[locale] = helper.translate_text(master_texts, locale, params[:platform])
+        end
+
+        update_translated_texts(base_directory, translated_texts, is_ios, params)
+      end
+
+      def self.list_locales(base_directory)
+        Dir.children(base_directory).select { |entry| File.directory?(File.join(base_directory, entry)) }
+      end
+
+      def self.fetch_master_texts(base_directory, master_locale, is_ios)
+        master_path = is_ios ? File.join(base_directory, master_locale) : File.join(base_directory, master_locale, 'changelogs')
+      
+        # Check if the master path exists
+        unless Dir.exist?(master_path)
+          UI.error("Master path does not exist: #{master_path}")
+          return nil
+        end
+      
+        filename = is_ios ? 'release_notes.txt' : highest_numbered_file(master_path)
+      
+        # Check if the file exists before reading
+        file_path = File.join(master_path, filename)
+        unless File.exist?(file_path)
+          UI.error("File does not exist: #{file_path}")
+          return nil
+        end
+      
+        File.read(file_path)
+      end      
+
+      def self.highest_numbered_file(directory)
+        Dir[File.join(directory, '*.txt')].max_by { |f| File.basename(f, '.txt').to_i }.split('/').last
+      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
+      
+          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
+      end
+      
+
+      def self.description
+        "Translate release notes or changelogs for iOS and Android apps using OpenAI's GPT API"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :api_token,
+            env_name: "GPT_API_KEY",
+            description: "API token for ChatGPT",
+            sensitive: true,
+            code_gen_sensitive: true,
+            default_value: ""
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :model_name,
+            env_name: "GPT_MODEL_NAME",
+            description: "Name of the ChatGPT model to use",
+            default_value: "gpt-4-1106-preview"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :request_timeout,
+            env_name: "GPT_REQUEST_TIMEOUT",
+            description: "Timeout for the request in seconds",
+            type: Integer,
+            default_value: 30
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :temperature,
+            env_name: "GPT_TEMPERATURE",
+            description: "What sampling temperature to use, between 0 and 2",
+            type: Float,
+            optional: true,
+            default_value: 0.5
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :master_locale,
+            env_name: "MASTER_LOCALE",
+            description: "Master language/locale for the source texts",
+            type: String,
+            default_value: "en-US"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :platform,
+            env_name: "PLATFORM",
+            description: "Platform for which to translate (ios or android)",
+            is_string: true, 
+            default_value: 'ios'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :context,
+            env_name: "GPT_CONTEXT",
+            description: "Context for translation to improve accuracy",
+            optional: true,
+            type: String
+          )
+        ]
+      end
+
+      def self.output
+        [
+          ['LOCALES_TRANSLATED', 'List of locales to which translations were applied'],
+          ['MASTER_LOCALE', 'The master language/locale used as the source for translations']
+        ]
+      end
+
+      def self.return_value
+        nil
+      end      
+
+      def self.authors
+        ["antonkarliner"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end      
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+require 'fastlane_core/ui/ui'
+require 'openai'
+require 'json'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class TranslateGptReleaseNotesHelper
+      def initialize(params)
+        @params = params
+        @client = OpenAI::Client.new(
+          access_token: params[:api_token],
+          request_timeout: params[:request_timeout]
+        )
+      end
+
+      # Request a translation from the GPT API
+      def translate_text(text, target_locale, platform)
+        source_locale = @params[:master_locale]
+        prompt = "Translate this text from #{source_locale} to #{target_locale}:\n#{text}"
+
+
+        # Add condition for Android platform
+        if platform == 'android'
+          prompt += "\n\nNote: The length of the translated text should be 500 symbols maximum. Rephrase a little if needed."
+        end
+
+        # Context handling
+        if @params[:context] && !@params[:context].empty?
+          prompt = "Context: #{@params[:context]}\n" + prompt
+        end
+
+        # Updated API call with max_tokens
+        response = @client.chat(
+          parameters: {
+            model: @params[:model_name] || 'gpt-4-1106-preview',
+            messages: [{ role: "user", content: prompt }],
+            temperature: @params[:temperature] || 0.5
+          }
+        )
+
+      
+        error = response.dig("error", "message")
+        if error
+          UI.error "Error translating text: #{error}"
+          return nil
+        else
+          translated_text = response.dig("choices", 0, "message", "content").strip
+          UI.message "Translated text: #{translated_text}"
+          return translated_text
+        end
+      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

@@ -0,0 +1,5 @@
+module Fastlane
+  module TranslateGptReleaseNotes
+    VERSION = "0.0.1"
+  end
+end

data/lib/fastlane/plugin/translate_gpt_release_notes.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/translate_gpt_release_notes/version'
+
+module Fastlane
+  module TranslateGptReleaseNotes
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::TranslateGptReleaseNotes.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-translate_gpt_release_notes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Karliner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: loco_strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.212.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.212.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: anton@karliner.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/translate_gpt_release_notes.rb
+- lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb
+- lib/fastlane/plugin/translate_gpt_release_notes/helper/translate_gpt_release_notes_helper.rb
+- lib/fastlane/plugin/translate_gpt_release_notes/version.rb
+homepage: https://github.com/antonkarliner/fastlane-plugin-translate_gpt_release_notes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/antonkarliner/fastlane-plugin-translate_gpt_release_notes
+  source_code_uri: https://github.com/antonkarliner/fastlane-plugin-translate_gpt_release_notes
+  github_repo: https://github.com/antonkarliner/fastlane-plugin-translate_gpt_release_notes
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Translate release notes or changelogs for iOS and Android apps using OpenAI
+  GPT API
+test_files: []