Added support for choosing the OpenAI model

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `ai-commit-message` will be documented in this file
 
+## v0.3.1 - 2023-05-04
+
+- Added support for choosing the OpenAI model using the `OPENAI_MODEL` environment variable. Users can now choose between 'gpt-3.5-turbo', 'gpt-4', and 'gpt-4-32k'.
+
 ## v0.3.0 - 2023-05-04
 
 - Refactored the code for better organization and readability

README.md

@@ -18,7 +18,7 @@ To use this action in your GitHub repository, follow these steps:
 
 1. Add a secret named `OPENAI_API_KEY` in your GitHub repository containing your OpenAI API key.
 
-2. Add the following workflow file to your repository in the .github/workflows directory, and name it ai_commit_message_generator.yml:
+2. Add the following workflow file to your repository in the .github/workflows directory, and name it ai_commit_message.yml:
 
 ```bash
 name: AI Commit Message Generator
@@ -40,14 +40,26 @@ jobs:
         uses: salehhashemi1992/ai-commit-message@v0.3.0
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          OPENAI_MODEL: gpt-3.5-turbo # Optional, you can use 'gpt-4' or 'gpt-4-32k' as well.
+
 ```
 
 Now, whenever you push a commit with the title [ai], this action will automatically generate a commit title and description using AI and update the commit message accordingly.
 
+### Configuration
+You can customize the behavior of this action using the following environment variables:
+
+#### OPENAI_API_KEY
+Required. The API key for accessing the OpenAI API.
+
+#### OPENAI_MODEL
+Optional. The OpenAI model you want to use.
+
+Supported values are 'gpt-3.5-turbo', 'gpt-4', and 'gpt-4-32k'. Defaults to 'gpt-3.5-turbo'.
+
 ### Known Bugs
 If you push a new commit before the title of the last commit has been updated, it will result in an issue where only the last commit title gets updated. To avoid this problem, please make sure to wait for the previous commit's title to be updated before pushing a new commit.
 
-
 ### Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

main.php

@@ -18,9 +18,18 @@ function main(): void
     $committerEmail = exec("git log -1 --pretty=%ce $commitSha");
 
     if ($commitTitle === '[ai]') {
+        $model = getenv('OPENAI_MODEL') ?: 'gpt-3.5-turbo'; // Default to gpt-3.5-turbo if no environment variable is set
+
+        if (!in_array($model, ['gpt-4', 'gpt-4-32k', 'gpt-3.5-turbo'])) {
+            echo "::error::Invalid model specified. Please use either gpt-3.5-turbo', 'gpt-4' or 'gpt-4-32k'." .
+                PHP_EOL;
+            exit(1);
+        }
+
         list($newTitle, $newDescription) = fetchAiGeneratedTitleAndDescription(
             getCommitChanges($commitSha),
-            getenv('OPENAI_API_KEY')
+            getenv('OPENAI_API_KEY'),
+            $model,
         );
 
         updateLastCommitMessage($newTitle, $newDescription, $committerEmail, $committerName);
@@ -29,15 +38,15 @@ function main(): void
 
 main();
 
-function fetchAiGeneratedTitleAndDescription(string $commitChanges, string $openAiApiKey): array
+function fetchAiGeneratedTitleAndDescription(string $commitChanges, string $openAiApiKey, string $model): array
 {
     $prompt = generatePrompt($commitChanges);
 
     $input_data = [
         "temperature" => 0.7,
         "max_tokens" => 300,
         "frequency_penalty" => 0,
-        'model' => 'gpt-3.5-turbo',
+        'model' => $model,
         "messages" => [
             [
                 'role' => 'user',
@@ -134,7 +143,13 @@ function getCommitChanges(string $commitSha): string
     exec($command, $output, $return_var);
 
     if ($return_var == 0) {
-        $output = array_slice($output, 0, 400);
+        $length = getenv('OPENAI_MODEL') ? match (getenv('OPENAI_MODEL')) {
+            'gpt-3.5-turbo' => 400,
+            'gpt-4' => 800,
+            'gpt-4-32k' => 3200,
+        } : 400;
+
+        $output = array_slice($output, 0, $length);
         return implode("\n", $output);
     } else {
         echo "Error: Could not run git diff. Return code: " . $return_var;