Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nfacha/OpenAI-Gitlab-PR-Review
Prototype Gitlab Webook that submits code to OpenAI for review
https://github.com/nfacha/OpenAI-Gitlab-PR-Review
ai chatgpt codereview gitlab openai
Last synced: 2 months ago
JSON representation
Prototype Gitlab Webook that submits code to OpenAI for review
- Host: GitHub
- URL: https://github.com/nfacha/OpenAI-Gitlab-PR-Review
- Owner: nfacha
- License: mit
- Created: 2023-04-11T20:23:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-18T15:45:48.000Z (8 months ago)
- Last Synced: 2024-08-02T22:20:51.827Z (5 months ago)
- Topics: ai, chatgpt, codereview, gitlab, openai
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 41
- Watchers: 2
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AI Code Reviewer
AI Code Reviewer is a Python script that leverages OpenAI's GPT-3.5-turbo to automatically review code changes in GitLab repositories. It listens for merge request and push events, fetches the associated code changes, and provides feedback on the changes in a Markdown format.
## Features
- Automatically reviews code changes in GitLab repositories
- Provides feedback on code clarity, simplicity, bugs, and security issues
- Generates Markdown-formatted responses for easy readability in GitLab
## Getting Started
### Prerequisites
- Python 3.8 or higher
- Docker (optional)
- An OpenAI API key
- A GitLab API token
### Installation
1. Clone the repository:
```
https://git.facha.dev/facha/openai-gitlab-pr-review.git
cd ai-code-reviewer
```
2. Install the required Python packages:
```
pip install -r requirements.txt
```
3. Create a `.env` file and set the required environment variables:
```
OPENAI_API_KEY=
GITLAB_TOKEN=
GITLAB_URL=https://gitlab.com/api/v4
EXPECTED_GITLAB_TOKEN=
```
4. Run the application:
```
python app.py
```
### Docker
Alternatively, you can use Docker to run the application:
1. Build the Docker image:
```
docker-compose build
```
2. Run the Docker container:
```
docker-compose up -d
```
## Usage
1. Configure your GitLab repository to send webhook events to the AI Code Reviewer application by following [GitLab's webhook documentation](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html).
2. The AI Code Reviewer application will automatically review code changes in your GitLab repository and provide feedback as comments on merge requests and commit diffs.