Feature/v0.0.19 alpha 20241103 (#24)

* 🔧 プルリクエストのタイトルと説明のフォーマットを改善

* 🔧 action.ymlとgenerate_pr_description.pyに新しい入力パラメータを追加し、プロンプトの指示内容を改善

* 🔧 generate-pr-description.ymlとaction.ymlでOpenAI言語の入力パラメータを追加し、モデルを更新

* 🔧 generate-pr-description.ymlでアクションのバージョンをv0.0.19-alphaに更新

.github/workflows/generate-pr-description.yml

@@ -20,8 +20,9 @@
         - uses: actions/checkout@v4
           with:
             fetch-depth: 0
-        - uses: tqer39/[email protected].16-alpha
+        - uses: tqer39/[email protected].19-alpha
           with:
             github-token: ${{ secrets.GITHUB_TOKEN }}
             openai-api-key: ${{ secrets.OPENAI_API_KEY }}
             openai-model: "gpt-4o"
+            openai-language: "ja"

action.yml

@@ -7,6 +7,10 @@ branding:
   icon: 'terminal'
 
 inputs:
+  commit-log-history-limit:
+    description: 'Commit log history limit'
+    required: true
+    default: '70'
   github-token:
     description: 'GitHub token'
     required: true
@@ -15,6 +19,10 @@ inputs:
     description: 'OpenAI API key'
     required: true
     default: ""
+  openai-language:
+    description: 'OpenAI Language'
+    required: true
+    default: 'en'
   # see https://platform.openai.com/docs/models#continuous-model-upgrades
   openai-model:
     description: 'OpenAI Model'
@@ -25,10 +33,6 @@ inputs:
     description: 'temperature'
     required: true
     default: '0.1'
-  commit-log-history-limit:
-    description: 'Commit log history limit'
-    required: true
-    default: '70'
 
 runs:
   using: 'composite'
@@ -54,10 +58,11 @@ runs:
 
     - name: Generate PR Title and Description
       env:
+        COMMIT_LOG_HISTORY_LIMIT: ${{ inputs.commit-log-history-limit }}
+        LANGUAGE: ${{ inputs.language }}
         OPENAI_API_KEY: ${{ inputs.openai-api-key }}
         OPENAI_MODEL: ${{ inputs.openai-model }}
         TEMPERATURE: ${{ inputs.temperature }}
-        COMMIT_LOG_HISTORY_LIMIT: ${{ inputs.commit-log-history-limit }}
       run: |
         uv run ${{ github.action_path }}/scripts/generate_pr_description.py > pr_output.txt
         cat pr_output.txt

scripts/generate_pr_description.py

@@ -24,7 +24,7 @@ def create_prompt(commit_logs: str) -> str:
     return f"""
     ## 指示内容
 
-    - 以下のコミットログとファイルの差分を読んで、理解し易いプルリクエストのタイトルと詳細な説明を日本語で作成してください。
+    - 以下のコミットログとファイルの差分を読んで、理解し易いプルリクエストのタイトルと詳細な説明を作成してください。
     -
     - 2行目以降は Markdown 形式で記述してください。
     - ファイル名はバッククオートで囲んでください。
@@ -39,22 +39,20 @@ def create_prompt(commit_logs: str) -> str:
     ```
 
     - プルリクエストのタイトル
-        - 1行目に出力してください。Markdown にしないでください。
-        - タイトルの冒頭には総合的に適した emoji をつけてください。
+        1. 1行目に出力してください。Markdown にしないでください。
+        2. タイトルの冒頭には総合的に適した emoji をつけてください。
     - プルリクエストの説明
-        - 2行目以降がプルリクエストの説明です。
-        - コミットログとファイルを読んで、変更点の概要と技術的な詳細や注意点を記述してください。
-            - なければ項目ごと出力しない。
-            - 嘘を書かない。
-        - 処理内容の図解が必要であれば mermaid.js の記法を使用する。
+        1. 2行目以降がプルリクエストの説明です。
+        2. コミットログとファイルを読んで、変更点の概要と技術的な詳細や注意点を記述してください。
+            1. なければ項目ごと出力しない。
+            2. 嘘を書かない。
+        3. 処理内容の図解が必要であれば mermaid.js の記法を使用する。
 
     ## コミットログとファイルの差分
 
     {commit_logs}
 
-    ## 出力形式
-
-    プルリクエストのタイトル
+    ## プルリクエストの説明
 
     ## 📒 変更点の概要
 
@@ -81,6 +79,7 @@ def generate_pr_description(commit_logs: str) -> str:
             {"role": "user", "content": prompt},
         ],
         max_tokens=1000,
+        language=os.getenv("OPENAI_LANGUAGE"),
         temperature=float(os.getenv("TEMPERATURE", "0.1")),
     )