Back to directory
cawcaw253 avatar
cawcaw253 / ai-review-action

ai-review-action

A GitHub Action that uses the OpenAI API to leave code review comments when Pull Requests are enabled.

21

Stars

4

Forks

3

Watchers

MIT

License

OpenAI PR Code Review Action

OpenAI generate code review when Pull Request opened.

review_example

How to use

When you use Personal Access Token, please check permission.


name: OpenAI PR Review
uses: cawcaw253/ai-review-action@latest
with:
  GITHUB_TOKEN: ${{ secrets.GH_PAT }}
  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
  LANGUAGE: "english"

If you use GITHUB_TOKEN, please check jobs permission when leave comment action failed.


name: OpenAI Code Review

on:
  pull_request:
    types: [opened, synchronize]

jobs:
  review:
    permissions: write-all # Check permission when leave comment action failed
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: OpenAI PR Review
        uses: cawcaw253/ai-review-action@latest
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          LANGUAGE: "korean"
          MODEL: "gpt-3.5-turbo"

Inputs

Inputs Description Required Default
OPENAI_API_KEY OpenAI Key for API call true <None>
GITHUB_TOKEN Token for checkout code and leave comment true <None>
LANGUAGE Language for comments false English
MODEL Model for chat completion false gpt-3.5-turbo

Outputs

Does not provide any outputs.

Releases

1.2.0 (2023-05-08) Feature

redefine all components (#28) (2db1b4a) split openai feature (#28) (0b30af3)

Bug Fixes

solve return issue (#28) (565857a) add max tokens variable (#28) (e6d30e3)

Tests...

1.1.3 (2023-04-09) Bug Fixes

remove dockerfile and use script directly (763b3a3)

Chores

bring input values from actions/core (61cbb7b)

1.1.2 (2023-04-09) Bug Fixes

update entrypoint path as relative path (0a24d97)

1.1.1 (2023-04-09) Bug Fixes

update dockerfile (bee2bcc)

Tests

dockerfile test (ebb6b68)

Chores

add dist (d405729) add delete dist folder at action (5da7387) add build job at test action (d3ab857...

1.1.0 (2023-04-08) Feature

add model select feature (0d96ae3)

Documentation

update readme (75bd8e1)

Chores

update default model (1221fbe) edit action (95a9137) update release pipeline with semant...