From 942813da7693a2417150de8ff3f7b251083ec3c1 Mon Sep 17 00:00:00 2001
From: Olivier Halligon <olivier.halligon@automattic.com>
Date: Mon, 2 Dec 2024 18:35:32 +0100
Subject: [PATCH] Add example `Fastfile` call as part of code doc

---
 .../actions/common/openai_generate_action.rb  | 22 +++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/openai_generate_action.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/openai_generate_action.rb
index 586a6a77f..310bcf10b 100644
--- a/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/openai_generate_action.rb
+++ b/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/openai_generate_action.rb
@@ -63,6 +63,10 @@ def self.format_message(role:, text:)
         }
       end
 
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
       def self.description
         'Use OpenAI API to generate response to a prompt'
       end
@@ -72,7 +76,7 @@ def self.authors
       end
 
       def self.return_value
-        'The response from the prompt as returned by OpenAI API'
+        'The response text from the prompt as returned by OpenAI API'
       end
 
       def self.details
@@ -82,6 +86,20 @@ def self.details
         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_generate(
+              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
@@ -115,7 +133,7 @@ def self.available_options
         ]
       end
 
-      def self.is_supported?(platform)
+      def self.is_supported?(_platform)
         true
       end
     end