Skip to content

OpenAI Code Review SDK 1.0

Latest

Choose a tag to compare

@captainLegoo captainLegoo released this 13 Aug 20:34
· 9 commits to main since this release
cc4b24a

Overview

Designed to improve code quality and development efficiency, this tool integrates seamlessly with GitHub Actions, triggering automatic reviews on every code push or pull request. The results are logged in a GitHub repository and can be sent via email to ensure that the relevant stakeholders are always informed.

Features

  • Automated Code Review: Automatically analyzes code changes using the GPT-4 API, providing detailed feedback on code quality, potential issues, and suggestions for improvement.
  • Seamless GitHub Actions Integration: The tool is integrated with GitHub Actions, allowing it to run automatically with every push or pull request, ensuring consistent and timely code reviews.
  • Logging and Archiving: The review results are automatically logged in a specified GitHub repository, providing a comprehensive archive of all reviews.
  • Email Notifications: Sends review summaries to designated email addresses, ensuring that the team stays updated on code quality.

Configuration

To set up the Open AI Code Review Tool in your repository, you will need to configure the following secrets in your GitHub repository settings:

  • OUTLOOK_USERNAME: The username for the email account that will send notifications
  • OUTLOOK_PASSWORD: The password or app-specific password for the email account
  • RECEIVER_EMAIL: The username for the email account that will receive notifications (can set multi-receiver)
  • GITHUB_REVIEW_LOG_URL: The URL of the GitHub repository where review logs will be stored
  • GITHUB_TOKEN: A GitHub token with appropriate access rights
  • CHATGPT_API_KEY: The API key to access the GPT-4 service

Once these secrets are configured, the GitHub Actions workflow provided in this repository will handle the rest