This project aims to automate code review using the GPT language model. It integrates with Github Actions and, upon receiving a Pull Request, automatically submits each code change to GPT for review.
The following steps will guide you in setting up the code review automation with GPT.
Before you begin, you need to have the following:
- An OpenAI API Key. You will need a personal API key from OpenAI which you can get here: https://openai.com/api/. To get an OpenAI API key, you can sign up for an account on the OpenAI website https://openai.com/signup/. Once you have signed up, you can create a new API key from your account settings.
- A Github account and a Github repository where you want to use the code review automation.
Create a secret for your OpenAI API Key in your Github repository or organization with the name openai_api_key. This secret will be used to authenticate with the OpenAI API.
You can do this by going to your repository/organization's settings, navigate to secrets and create a new secret with the name openai_api_key and paste your OpenAI API key as the value.
Then you need to set up your project's permissions so that the Github Actions can write comments on Pull Requests. You can read more about this here: automatic-token-authentication
Step 3: Create a new Github Actions workflow in your repository in `.github/workflows/chatgpt-review.yaml. A sample workflow is given below:
on:
pull_request:
types: [opened, synchronize]
jobs:
code_review_job:
runs-on: ubuntu-latest
name: ChatGPT Code Review
steps:
- name: GenAI Code Review
uses: cirolini/genai-code-review@v2
with:
openai_api_key: ${{ secrets.openai_api_key }}
github_token: ${{ secrets.GITHUB_TOKEN }}
github_pr_id: ${{ github.event.number }}
openai_model: "gpt-3.5-turbo" # optional
openai_temperature: 0.5 # optional
openai_max_tokens: 2048 # optional
mode: files # files or patch
language: en # optional, default is 'en'
custom_prompt: "" # optional
In the above workflow, the pull_request event triggers the workflow whenever a pull request is opened or synchronized. The workflow runs on the ubuntu-latest runner and uses the cirolini/chatgpt-github-actions@v1 action.
The openai_api_key is passed from the secrets context, and the github_token is also passed from the secrets context. The github_pr_id is passed from the github.event.number context. The other three input parameters, openai_engine, openai_temperature, and openai_max_tokens, are optional and have default values.
- Description: The OpenAI model to use for generating responses.
- Default:
"gpt-3.5-turbo" - Options: Models like
gpt-4o,gpt-4-turbo, etc.
- Description: Controls the creativity of the AI's responses. Higher values make the output more random, while lower values make it more focused and deterministic.
- Default:
0.5 - Range:
0.0to1.0
- Description: The maximum number of tokens to generate in the completion.
- Default:
2048 - Range: Up to the model's maximum context length.
- Description: Determines the method of analysis for the pull request.
- Options:
files: Analyzes the files changed in the last commit.patch: Analyzes the patch content.
- Description: The language in which the review comments will be written.
- Default:
en(English) - Options: Any valid language code, e.g.,
pt-brfor Brazilian Portuguese.
- Description: Custom instructions for the AI to follow when generating the review.
- Default:
""(empty) - Usage: Provide specific guidelines or focus areas for the AI's code review.
This action is triggered when a pull request is opened or updated. The action authenticates with the OpenAI API using the provided API key, and with the Github API using the provided token. It then selects the repository using the provided repository name, and the pull request ID. For each commit in the pull request, it gets the modified files, gets the file name and content, sends the code to ChatGPT for an explanation, and adds a comment to the pull request with ChatGPT's response.
Every PR has a file called patch which is where the difference between 2 files, the original and the one that was changed, is, this strategy consists of reading this file and asking the AI to summarize the changes made to it.
Comments will appear like this:
The custom_prompt parameter allows users to tailor the AI's review to specific needs. By providing custom instructions, users can focus the review on particular aspects or request additional information. This flexibility enhances the usefulness of the AI-generated review comments.
To use a custom prompt, simply provide a string with your instructions. For example, to ask the AI to rate the code on a scale of 1 to 10, set the custom_prompt parameter as follows:
custom_prompt: "Give a rating from 1 to 10 for this code:"Using a custom prompt can direct the AI to focus on specific areas, such as:
- Code quality and readability
- Security vulnerabilities
- Performance optimizations
- Adherence to coding standards
- Specific concerns or questions about the code
The custom_prompt is integrated into the review generation as shown:
if custom_prompt:
logging.info(f"Using custom prompt: {custom_prompt}")
return f"{custom_prompt}\n### Code\n```{content}```\n\nWrite this code review in the following {language}:\n\n"
return (f"Please review the following code for clarity, efficiency, and adherence to best practices. "
f"Identify any ar...
This feature allows you to harness the power of AI in a way that best suits your specific code review requirements.
When sending code to the ChatGPT language model, it is important to consider the security and privacy of the code because user data may be collected and used to train and improve the model, so it's important to have proper caution and privacy policies in place.. OpenAI takes security seriously and implements measures to protect customer data, such as encryption of data in transit and at rest, and implementing regular security audits and penetration testing. However, it is still recommended to use appropriate precautions when sending sensitive or confidential code, such as removing any sensitive information or obscuring it before sending it to the model. Additionally, it is a good practice to use a unique API key for each project and to keep the API key secret, for example by storing it in a Github secret. This way, if the API key is ever compromised, it can be easily revoked, limiting the potential impact on the user's projects.
- OpenAI - The AI platform used
- Github Actions - Automation platform
- CiroLini - cirolini
- Glauber Borges - glauberborges
This project is licensed under the MIT License - see the LICENSE file for details.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent