add PROMPT var

Author: anc95

.env.example

@@ -17,4 +17,5 @@ LANGUAGE=
 MODEL=
 temperature=
 top_p=
-TARGET_LABEL=
+TARGET_LABEL=
+PROMPT=Bellow is a code diff, please help me do a code review

README.ja.md

@@ -6,7 +6,7 @@ Translation Versions: [ENGLISH](./README.md) | [中文简体](./README.zh-CN.md)
 
 ## Usage
 
-❗️⚠️ コストを考慮してBOTはテスト目的でのみ使用され、現在AWS Lambdaに展開されて速度制限を受けています。そのため、不安定な状況は完全に正常です。アプリケーションを直接展開することをお勧めします。
+❗️⚠️ コストを考慮して BOT はテスト目的でのみ使用され、現在 AWS Lambda に展開されて速度制限を受けています。そのため、不安定な状況は完全に正常です。アプリケーションを直接展開することをお勧めします。
 
 ## Install
 
@@ -17,12 +17,12 @@ Install: [apps/cr-gpt](https://github.com/apps/cr-gpt);
 1. リポジトリのホームページに移動します
 2. `settings` をクリックします
 3. `secrets and variables` メニューの下の `actions` をクリックします
-4. `New repository variable` をクリックしてOpenAI の APIキーの登録を行います。変数名は `OPENAI_API_KEY` にしてください。変数の値にはOpenAIのAPIキーを入力します。 (OpenAIのホームページからAPIキーを取得できます。)
+4. `New repository variable` をクリックして OpenAI の API キーの登録を行います。変数名は `OPENAI_API_KEY` にしてください。変数の値には OpenAI の API キーを入力します。 (OpenAI のホームページから API キーを取得できます。)
    <img width="1465" alt="image" src="https://user-images.githubusercontent.com/13167934/218533628-3974b70f-c423-44b0-b096-d1ec2ace85ea.png">
 
 ### Start using
 
-1. このbotは新しいプルリクエストが作成されたときに自動的にコードレビューを行います。レビュー結果はプルリクエストのタイムラインやファイル変更部分に表示されます。
+1. この bot は新しいプルリクエストが作成されたときに自動的にコードレビューを行います。レビュー結果はプルリクエストのタイムラインやファイル変更部分に表示されます。
 2. `git push` によりプルリクエストの更新が行われたときにも自動的にコードレビューを行います。
 
 example:
@@ -63,6 +63,7 @@ jobs:
           # Optional
           LANGUAGE: Chinese
           MODEL:
+          PROMPT:
           top_p: 1
           temperature: 1
 ```
@@ -71,7 +72,7 @@ jobs:
 
 1. このリポジトリをクローンします
 2. `.env.example` を `.env` にリネームし、必要な環境変数を設定します
-3. 以下のコマンドを順番に実行することで依存関係をインストールし、botを起動します
+3. 以下のコマンドを順番に実行することで依存関係をインストールし、bot を起動します
 
 ```sh
 npm i

README.ko.md

@@ -7,6 +7,7 @@ Translation Versions: [ENGLISH](./README.md) | [中文简体](./README.zh-CN.md)
 ## 사용법
 
 ❗️⚠️비용을 고려하여 BOT은 테스트 목적으로만 사용되며, 현재 AWS Lambda에 배포되어 속도 제한을 받고 있습니다. 따라서 불안정한 상황은 완전히 정상적입니다. 응용 프로그램을 직접 배포하는 것이 좋습니다.
+
 ### 설치
 
 설치: [apps/cr-gpt](https://github.com/apps/cr-gpt);
@@ -58,7 +59,9 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          # optional
           LANGUAGE: Korean
+          PROMPT:
 ```
 
 ## Self-hosting

README.md

@@ -6,7 +6,7 @@ Translation Versions: [ENGLISH](./README.md) | [中文简体](./README.zh-CN.md)
 
 ## Bot Usage
 
- ❗️⚠️ `Due to cost considerations, BOT is only used for testing purposes and is currently deployed on AWS Lambda with ratelimit restrictions. Therefore, unstable situations are completely normal. It is recommended to deploy an app by yourself.`
+❗️⚠️ `Due to cost considerations, BOT is only used for testing purposes and is currently deployed on AWS Lambda with ratelimit restrictions. Therefore, unstable situations are completely normal. It is recommended to deploy an app by yourself.`
 
 ### Install
 
@@ -62,6 +62,7 @@ jobs:
           LANGUAGE: Chinese
           OPENAI_API_ENDPOINT: https://api.openai.com/v1
           MODEL:
+          PROMPT:
           top_p: 1
           temperature: 1
 ```

README.zh-CN.md

@@ -6,7 +6,7 @@
 
 ## 用法
 
-❗️⚠️ 鉴于成本考虑，BOT仅用于测试目的，并目前在AWS Lambda上部署并受到速率限制。因此，不稳定的情况是完全正常的。建议自己部署应用程序。
+❗️⚠️ 鉴于成本考虑，BOT 仅用于测试目的，并目前在 AWS Lambda 上部署并受到速率限制。因此，不稳定的情况是完全正常的。建议自己部署应用程序。
 
 ### 安装
 
@@ -17,12 +17,12 @@
 1.  转到你要集成此机器人的仓库首页
 2.  点击`settings`
 3.  点击`actions`在下面`secrets and variables`
-4.  切换到`Variables`选项，创建一个新变量`OPENAI_API_KEY`，值为你的open api 的key<img width="1465" alt="image" src="https://user-images.githubusercontent.com/13167934/218533628-3974b70f-c423-44b0-b096-d1ec2ace85ea.png">
+4.  切换到`Variables`选项，创建一个新变量`OPENAI_API_KEY`，值为你的 open api 的 key<img width="1465" alt="image" src="https://user-images.githubusercontent.com/13167934/218533628-3974b70f-c423-44b0-b096-d1ec2ace85ea.png">
 
 ### 开始使用
 
 1.  当你创建一个新的 Pull request 时，机器人会自动进行代码审查，审查信息将显示在 pr timeline / file changes 部分。
-2.  在`git push`更新PR之后，cr bot 将重新审查更改的文件
+2.  在`git push`更新 PR 之后，cr bot 将重新审查更改的文件
 
 例子：
 
@@ -58,14 +58,16 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          # optional
           LANGUAGE: Chinese
+          PROMPT:
 ```
 
 ## 自托管
 
 1.  克隆代码
 2.  复制`.env.example`到`.env`, 并填写环境变量
-3.  安装deps并运行
+3.  安装 deps 并运行
 
 ```sh
 npm i
@@ -111,4 +113,3 @@ docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> cr-bot
 ## License
 
 [ISC](LICENSE)© 2023 anc95
-

README.zh-TW.md

@@ -15,12 +15,12 @@
 1.  轉到你要集成此機器人的倉庫首頁
 2.  點擊`settings`
 3.  點擊`actions`在下面`secrets and variables`
-4.  切換到`Variables`選項，創建一個新變量`OPENAI_API_KEY`，值為你的open api 的key<img width="1465" alt="image" src="https://user-images.githubusercontent.com/13167934/218533628-3974b70f-c423-44b0-b096-d1ec2ace85ea.png">
+4.  切換到`Variables`選項，創建一個新變量`OPENAI_API_KEY`，值為你的 open api 的 key<img width="1465" alt="image" src="https://user-images.githubusercontent.com/13167934/218533628-3974b70f-c423-44b0-b096-d1ec2ace85ea.png">
 
 ### 開始使用
 
 1.  當你創建一個新的 Pull request 時，機器人會自動進行代碼審查，審查信息將顯示在 pr timeline / file changes 部分。
-2.  在`git push`更新PR之後，cr bot 將重新審查更改的文件
+2.  在`git push`更新 PR 之後，cr bot 將重新審查更改的文件
 
 例子：
 
@@ -56,13 +56,15 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          # optional
+          PROMPT:
 ```
 
 ## 自托管
 
 1.  克隆代碼
 2.  復製`.env.example`到`.env`, 並填寫環境變量
-3.  安裝deps並運行
+3.  安裝 deps 並運行
 
 ```sh
 npm i

action/index.cjs

@@ -148165,18 +148165,21 @@ const robot = (app) => {
         const repo = context.repo();
         const chat = await loadChat(context);
         if (!chat) {
+            console.log('Chat initialized fialed');
             return 'no chat';
         }
         const pull_request = context.payload.pull_request;
         if (pull_request.state === 'closed' ||
             pull_request.locked ||
             pull_request.draft) {
+            console.log('invalid event paylod');
             return 'invalid event paylod';
         }
         const target_label = process.env.TARGET_LABEL;
         if (target_label &&
             (!pull_request.labels?.length ||
                 pull_request.labels.every((label) => label.name !== target_label))) {
+            console.log('no target label attached');
             return 'no target label attached';
         }
         const data = await context.octokit.repos.compareCommits({
@@ -148197,6 +148200,7 @@ const robot = (app) => {
             changedFiles = changedFiles?.filter((file) => filesNames.includes(file.filename));
         }
         if (!changedFiles?.length) {
+            console.log('no target label attached');
             return 'no change';
         }
         console.time('gpt cost');
@@ -148207,6 +148211,7 @@ const robot = (app) => {
                 continue;
             }
             if (!patch || patch.length > MAX_PATCH_COUNT) {
+                console.log(`${file.filename} skipped caused by its diff is too large`);
                 continue;
             }
             const res = await chat?.codeReview(patch);
@@ -148256,7 +148261,9 @@ class Chat {
         const answerLanguage = process.env.LANGUAGE
             ? `Answer me in ${process.env.LANGUAGE},`
             : '';
-        return `Bellow is the code patch, please help me do a brief code review,${answerLanguage} if any bug risk and improvement suggestion are welcome
+        const prompt = process.env.PROMPT ||
+            'Bellow is the code patch, please help me do a brief code review, if any bug risk and improvement suggestion are welcome';
+        return `${prompt}, ${answerLanguage}:
     ${patch}
     `;
     };

src/chat.ts

@@ -19,7 +19,11 @@ export class Chat {
       ? `Answer me in ${process.env.LANGUAGE},`
       : '';
 
-    return `Bellow is the code patch, please help me do a brief code review,${answerLanguage} if any bug risk and improvement suggestion are welcome
+    const prompt =
+      process.env.PROMPT ||
+      'Bellow is the code patch, please help me do a brief code review, if any bug risk and improvement suggestion are welcome';
+
+    return `${prompt}, ${answerLanguage}:
     ${patch}
     `;
   };