fastlane-plugin-wpmreleasetoolkit 12.3.4 → 12.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b59d8ce8652d5491809fc8a80bf3e08b35a3d65f244eb9f7f8faccb212ba9c81
-  data.tar.gz: aea9e1d13eb564f07088120c9f763aa2042bc34c0672ca938670b0ee1e698209
+  metadata.gz: d4cdbaa88428a89afebe8e5ccddc35bc4ebce263ae07caa40598fc54bec24fca
+  data.tar.gz: a16e7052eddb43d6f98aab25c51ad2628d702b54842f726ee4c1fde45003eb02
 SHA512:
-  metadata.gz: c3dca2f486e3ff752f89b8b27a36d5f2287dc9c529eb46efe10ca6c6168ebfa595489921ae4a550c80e6b1f10f616401ba53e8e1ce102210f478c79f16bbde6a
-  data.tar.gz: 3dc7792faa4d46efabde9c7075f198dae635b15be7a9cc9a157610c23fec524ed3a5ebb28e6e3377cb0e5313a313579debcc1ee41abb10308eaafcb063b0c427
+  metadata.gz: 6c2999022ddf9da5acaaf1085344a31458a88c048daa6b3ef91350f8875fcdb94326d3c29335abcbab965eb507112cab0d45d3fb75fe826f01f2f185ee843857
+  data.tar.gz: '08151bb5c92923d4733f0a3aa590c03a912dcc5378099482c8e2388334849d85e9fa2c826c5c69e13e985b31a2171b136daf4d6779f0d750ac2df54a9c2b9d76'

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

@@ -8,16 +8,18 @@ module Fastlane
         release_notes_file_path = params[:release_notes_file_path]
         extracted_notes_file_path = params[:extracted_notes_file_path]
 
-        extracted_notes_file = File.open(extracted_notes_file_path, 'w') unless extracted_notes_file_path.blank?
-
+        extracted_notes = ''
         extract_notes(release_notes_file_path, version) do |line|
-          extracted_notes_file.nil? ? puts(line) : extracted_notes_file.write(line)
+          extracted_notes += line
         end
+        extracted_notes.chomp!('') # Remove any extra empty line(s) at the end
 
-        return if extracted_notes_file.nil?
+        unless extracted_notes_file_path.nil? || extracted_notes_file_path.empty?
+          File.write(extracted_notes_file_path, extracted_notes)
+          commit_extracted_notes_file(extracted_notes_file_path, version)
+        end
 
-        extracted_notes_file.close
-        check_and_commit_extracted_notes_file(extracted_notes_file_path, version)
+        extracted_notes
       end
 
       def self.extract_notes(release_notes_file_path, version)
@@ -39,9 +41,13 @@ module Fastlane
         end
       end
 
-      def self.check_and_commit_extracted_notes_file(file_path, version)
-        Action.sh("git add #{file_path}")
-        Action.sh("git diff-index --quiet HEAD || git commit -m \"Update draft release notes for #{version}.\"")
+      def self.commit_extracted_notes_file(file_path, version)
+        other_action.git_add(path: file_path)
+        other_action.git_commit(
+          path: file_path,
+          message: "Update draft release notes for #{version}",
+          allow_nothing_to_commit: true
+        )
       end
 
       def self.description
@@ -53,7 +59,7 @@ module Fastlane
       end
 
       def self.return_value
-        # If your method provides a return value, you can describe here what it does
+        'The content of the extracted release notes (the same text as what was written in the `extracted_notes_file_path` if one was provided)'
       end
 
       def self.details

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

@@ -0,0 +1,141 @@
+require 'fastlane/action'
+require 'net/http'
+require 'json'
+
+module Fastlane
+  module Actions
+    class OpenaiAskAction < Action
+      OPENAI_API_ENDPOINT = URI('https://api.openai.com/v1/chat/completions').freeze
+
+      PREDEFINED_PROMPTS = {
+        release_notes: <<~PROMPT.freeze
+          Act like a mobile app marketer who wants to prepare release notes for Google Play and App Store.
+          Do not write it point by point and keep it under 350 characters. It should be a unique paragraph.
+
+          When provided a list, use the number of any potential "*" in brackets at the start of each item as indicator of importance.
+          Ignore items starting with "[Internal]", and ignore links to GitHub.
+        PROMPT
+      }.freeze
+
+      def self.run(params)
+        api_token = params[:api_token]
+        prompt = params[:prompt]
+        prompt = PREDEFINED_PROMPTS[prompt] if PREDEFINED_PROMPTS.key?(prompt)
+        question = params[:question]
+
+        headers = {
+          'Content-Type': 'application/json',
+          Authorization: "Bearer #{api_token}"
+        }
+        body = request_body(prompt: prompt, question: question)
+
+        response = Net::HTTP.post(OPENAI_API_ENDPOINT, body, headers)
+
+        case response
+        when Net::HTTPOK
+          json = JSON.parse(response.body)
+          json['choices']&.first&.dig('message', 'content')
+        else
+          UI.user_error!("Error in OpenAI API response: #{response}. #{response.body}")
+        end
+      end
+
+      def self.request_body(prompt:, question:)
+        {
+          model: 'gpt-4o',
+          response_format: { type: 'text' },
+          temperature: 1,
+          max_tokens: 2048,
+          top_p: 1,
+          messages: [
+            format_message(role: 'system', text: prompt),
+            format_message(role: 'user', text: question),
+          ].compact
+        }.to_json
+      end
+
+      def self.format_message(role:, text:)
+        return nil if text.nil? || text.empty?
+
+        {
+          role: role,
+          content: [{ type: 'text', text: text }]
+        }
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Use OpenAI API to generate response to a prompt'
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.return_value
+        'The response text from the prompt as returned by OpenAI API'
+      end
+
+      def self.details
+        <<~DETAILS
+          Uses the OpenAI API to generate response to a prompt.
+          Can be used to e.g. ask it to generate Release Notes based on a bullet point technical changelog or similar.
+        DETAILS
+      end
+
+      def self.examples
+        [
+          <<~EXEMPLE,
+            items = extract_release_notes_for_version(version: app_version, release_notes_file_path: 'RELEASE-NOTES.txt')
+            nice_changelog = openai_ask(
+              prompt: :release_notes, # Uses the pre-crafted prompt for App Store / Play Store release notes
+              question: "Help me write release notes for the following items:\n#{items}",
+              api_token: get_required_env('OPENAI_API_TOKEN')
+            )
+            File.write(File.join('fastlane', 'metadata', 'android', 'en-US', 'changelogs', 'default.txt'), nice_changelog)
+          EXEMPLE
+        ]
+      end
+
+      def self.available_prompt_symbols
+        PREDEFINED_PROMPTS.keys.map { |v| "`:#{v}`" }.join(',')
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :prompt,
+                                       description: 'The internal top-level instructions to give to the model to tell it how to behave. ' \
+                                        + "Use a Ruby Symbol from one of [#{available_prompt_symbols}] to use a predefined prompt instead of writing your own",
+                                       optional: true,
+                                       default_value: nil,
+                                       type: String,
+                                       skip_type_validation: true,
+                                       verify_block: proc do |value|
+                                         next if value.is_a?(String)
+                                         next if PREDEFINED_PROMPTS.include?(value)
+
+                                         UI.user_error!("Parameter `prompt` can only be a String or one of the following Symbols: [#{available_prompt_symbols}]")
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :question,
+                                       description: 'The user message to ask the question to the OpenAI model',
+                                       optional: false,
+                                       default_value: nil,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       description: 'The OpenAI API Token to use for the request',
+                                       env_name: 'OPENAI_API_TOKEN',
+                                       optional: false,
+                                       sensitive: true,
+                                       type: String),
+        ]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

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

@@ -2,6 +2,6 @@
 
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '12.3.4'
+    VERSION = '12.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 12.3.4
+  version: 12.4.0
 platform: ruby
 authors:
 - Automattic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -423,6 +423,7 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/get_prs_between_tags.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/gp_downloadmetadata_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/gp_update_metadata_source.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/actions/common/openai_ask_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/promo_screenshots_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/prototype_build_details_comment_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/publish_github_release_action.rb