AI Docs Critic

From @johnmulhausen: This is a hacky fork of https://github.com/freeedcom/ai-codereviewer by @freeedcom, adapted for docs review purposes. The README for their AI Code Reviewer is as follows:

AI Code Reviewer

AI Code Reviewer is a GitHub Action that leverages OpenAI's GPT-4 API to provide intelligent feedback and suggestions on your pull requests. This powerful tool helps improve code quality and saves developers time by automating the code review process.

Features

• Reviews pull requests using OpenAI's GPT-4 API.
• Provides intelligent comments and suggestions for improving your code.
• Filters out files that match specified exclude patterns.
• Easy to set up and integrate into your GitHub workflow.

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.

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.

3. Create a .github/workflows/ai-docs-critic.yml file in your repository and add the following content:

name: AI Docs Critic
on:
  pull_request:
    types:
      - opened
      - synchronize
permissions: write-all
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v3
      - name: AI Docs Critic
        uses: johndmulhausen/ai-docs-critic@1.0
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL: "gpt-4" # Optional: defaults to "gpt-4"
          exclude: "**/*.json, **/*.html, **/*.txt, **/*.yml, **.*.yaml, **/*.toml, **/*.js, **/*.sass, **/*.css" # Optional: exclude patterns separated by commas

4. Add a GitHub token as a secret to your repository with the name GITHUB_TOKEN. You can find more information about GitHub Secrets here.

5. Customize the exclude input if you want to ignore certain file patterns from being reviewed.

6. Commit the changes to your repository, and AI Code Reviewer will start working on your future pull requests.

How It Works

The AI Code Reviewer GitHub Action retrieves the pull request diff, filters out excluded files, and sends code chunks to the OpenAI API. It then generates review comments based on the AI's response and adds them to the pull request.

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests to improve the AI Code Reviewer GitHub Action.

Let the maintainer generate the final package.

License

This project is licensed under the MIT License. See the LICENSE file for more information.