diff --git a/README.md b/README.md index 566a3ea1..8283ca3f 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ jobs: with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} + COMMENT_LANGUAGE: ${{ secrets.COMMENT_LANGUAGE }} OPENAI_API_MODEL: "gpt-4" # Optional: defaults to "gpt-4" exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas ``` @@ -51,7 +52,9 @@ jobs: 5. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed. -6. Commit the changes to your repository, and AI Code Reviewer will start working on your future pull requests. +6. Replace the `COMMENT_LANGUAGE` input if you want to add comments in your desired language. + +7. Commit the changes to your repository, and AI Code Reviewer will start working on your future pull requests. ## How It Works diff --git a/action.yml b/action.yml index 976aed73..83033332 100644 --- a/action.yml +++ b/action.yml @@ -11,6 +11,9 @@ inputs: description: "OpenAI API model." required: false default: "gpt-4" + COMMENT_LANGUAGE: + description: "input if you want to add comments in your desired language." + required: false exclude: description: "Glob patterns to exclude files from the diff analysis" required: false diff --git a/src/main.ts b/src/main.ts index 13677ae4..247ae2db 100644 --- a/src/main.ts +++ b/src/main.ts @@ -8,6 +8,7 @@ import minimatch from "minimatch"; const GITHUB_TOKEN: string = core.getInput("GITHUB_TOKEN"); const OPENAI_API_KEY: string = core.getInput("OPENAI_API_KEY"); const OPENAI_API_MODEL: string = core.getInput("OPENAI_API_MODEL"); +const COMMENT_LANGUAGE: string = core.getInput("COMMENT_LANGUAGE"); const octokit = new Octokit({ auth: GITHUB_TOKEN }); @@ -86,7 +87,7 @@ function createPrompt(file: File, chunk: Chunk, prDetails: PRDetails): string { - Write the comment in GitHub Markdown format. - Use the given description only for the overall context and only comment the code. - IMPORTANT: NEVER suggest adding comments to the code. - +${COMMENT_LANGUAGE ? `- Write the comments in ${COMMENT_LANGUAGE}.\n` : ''} Review the following code diff in the file "${ file.to }" and take the pull request title and description into account when writing the response.