Class: Fastlane::Actions::TranslateGptReleaseNotesAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



170
171
172
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 170

def self.authors
  ["antonkarliner"]
end

.available_options ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 104

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-turbo-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

.description ⇒ Object 



100
101
102
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 100

def self.description
  "Translate release notes or changelogs for iOS and Android apps using OpenAI's GPT API"
end

.fetch_master_texts(base_directory, master_locale, is_ios) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 58

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, nil]
  end

  filename = is_ios ? 'release_notes.txt' : highest_numbered_file(master_path)
  file_path = File.join(master_path, filename)

  # Check if the file exists before reading
  unless File.exist?(file_path)
    UI.error("File does not exist: #{file_path}")
    return [nil, nil]
  end

  [File.read(file_path), file_path]
end

.highest_numbered_file(directory) ⇒ Object 



80
81
82
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 80

def self.highest_numbered_file(directory)
  Dir[File.join(directory, '*.txt')].max_by { |f| File.basename(f, '.txt').to_i }.split('/').last
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


174
175
176
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 174

def self.is_supported?(platform)
  [:ios, :android].include?(platform)
end

.list_locales(base_directory) ⇒ Object 



54
55
56
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 54

def self.list_locales(base_directory)
  Dir.children(base_directory).select { |entry| File.directory?(File.join(base_directory, entry)) }
end

.output ⇒ Object 



159
160
161
162
163
164
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 159

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

.return_value ⇒ Object 



166
167
168
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 166

def self.return_value
  nil
end

.run(params) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 9

def self.run(params)
  # Define the path for the last run time file
  last_run_file = "last_successful_run.txt"

  # 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, master_file_path = fetch_master_texts(base_directory, params[:master_locale], is_ios)

  # Skip translation if master texts are not found
  unless master_texts && master_file_path
    UI.message("Master file not found, skipping translation.")
    return
  end
  
  # Compare last modification time with the last run time
  if File.exist?(last_run_file) && File.exist?(master_file_path)
    last_run_time = File.read(last_run_file).to_i
    file_mod_time = File.mtime(master_file_path).to_i
    if file_mod_time <= last_run_time
      UI.message("No changes in source file detected, translation skipped.")
      return
    end
  end

  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)

  # Store the current time as the last run time
  File.write(last_run_file, Time.now.to_i)
end

.update_translated_texts(base_directory, translated_texts, is_ios, params) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/fastlane/plugin/translate_gpt_release_notes/actions/translate_gpt_release_notes_action.rb', line 84

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