README.md

openai-for-prs

GitHub action to get PR recommendations from OpenAI.

• The action is triggered when a PR is opened or updated.
• The action retrieves the PR comments and title and passes them to the OpenAI API.
• The OpenAI API analyzes the code and generates a PR suggestions.
• The action adds a comment in the PR with the recommendations from OpenAI.

Usage

Inputs

• openai-token - Your secret API key from OpenAI
• tokens - The maximum number of tokens to generate in the completion.
• max-files - The maximum number of files to review

Example workflow

name: Get PR recommendations
on:
  pull_request:
    branches: [ "main" ]

jobs:
  get-recommendation:
    runs-on: ubuntu-latest
    name: Get a PR recommendation from OpenAI
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Get AI comment
        uses: WesternHemlock/openai-for-prs@main
        with:
          openai-token: ${{ secrets.OPENAI_API_KEY }}
          tokens: 2500
          max-files: 5

Note You must use actions/checkout before the openai-for-prs step. If you use actions/checkout@v2, you must specify a commit depth other than the default, which is 1—using a fetch-depth of '0' clones the entire history. If you want to do a more efficient clone, use '2', which is not guaranteed to work with pull requests.

Example PR comment