https://github.com/brainstormforce/pull-request-reviewer
PR Reviewer is a simple, lightweight tool for reviewing GitHub Pull Requests. It streamlines the code review process by providing a clean interface to view and comment on diffs, see reviewer feedback, and manage multiple PRs efficiently.
https://github.com/brainstormforce/pull-request-reviewer
Last synced: 5 months ago
JSON representation
PR Reviewer is a simple, lightweight tool for reviewing GitHub Pull Requests. It streamlines the code review process by providing a clean interface to view and comment on diffs, see reviewer feedback, and manage multiple PRs efficiently.
- Host: GitHub
- URL: https://github.com/brainstormforce/pull-request-reviewer
- Owner: brainstormforce
- Created: 2024-10-17T10:17:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-18T10:25:33.000Z (over 1 year ago)
- Last Synced: 2024-11-18T11:51:36.387Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 6.62 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BSF AI Code Reviewer
The BSF AI Code Reviewer is an AI-powered code review system that leverages OpenAI to provide automatic feedback on code quality, following industry standards and best practices. It helps in identifying code smells, potential security risks, and adherence to coding conventions.
# Features
- Leverages OpenAI's API to automatically review pull requests.
- Delivers smart comments and recommendations for enhancing code quality and security.
- Auto approve the PR if no actionable comments are found.
- Auto resolve the comments if the code changes are made and accepted.
- Supports php, js & jsx files
- Simple setup and seamless integration with GitHub workflows.
# Shortcodes
- **[BSF-PR-SUMMARY]** - This shortcode will display the summary of the PR review.
## Setup
1. To use this GitHub Action, you need an OpenAI API key. If you don't have one, sign up for an API key
at [OpenAI](https://beta.openai.com/signup).
2. Add the OpenAI API key as a GitHub Secret in your repository with the name `OPENAI_API_KEY`. You can find more
information about GitHub Secrets [here](https://docs.github.com/en/actions/reference/encrypted-secrets).
3. Create a `.github/workflows/bsf-pr-review.yml` file in your repository and add the following content:
```yaml
name: BSF Code Reviewer
on:
pull_request:
types: [opened, synchronize, edited]
permissions: write-all
jobs:
CHECK_SHORTCODE:
if: contains(github.event.pull_request.body, '[BSF-PR-SUMMARY]')
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3
- name: WRITE PR SUMMARY
uses: brainstormforce/pull-request-reviewer@master
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
ACTION_CONTEXT: 'CHECK_SHORTCODE'
EXCLUDE_EXTENSIONS: "md, yml, lock"
INCLUDE_EXTENSIONS: "php, js, jsx, ts, tsx, css, scss, html, json"
EXCLUDE_PATHS: "node_modules/,vendor/"
CODE_REVIEW:
needs: CHECK_SHORTCODE
if: always()
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3
- name: AI CODE REVIEW
uses: brainstormforce/pull-request-reviewer@master
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
ACTION_CONTEXT: "CODE_REVIEW"
EXCLUDE_EXTENSIONS: "md, yml, lock"
INCLUDE_EXTENSIONS: "php, js, jsx, ts, tsx, css, scss, html, json"
EXCLUDE_PATHS: "node_modules/,vendor/"
```