v3.0.0

What's New

• feat: 🛠️ integrate Deepseek R1 using OpenRouter 🥇 by @murtuzaalisurti in #10
• This integration with OpenRouter only supports deepseek models for now.
• If you want to use a deepseek model, get an OpenRouter API key.

What's Changed

• With this version, a retry mechanism kicks in whenever a model encounters a failure and the max retries are set to 3 by default. This may lead to more token consumption - which is why set the max-retries option to 0 if retries are not needed.

Other updates

• dependency upgrades - 99f2b69, 2bd1de8, 1f72112

Full Changelog: v2.1.0...v3.0.0

v2.1.0

What's New

• feat 🛠️ integrate Mistral AI 📥 by @murtuzaalisurti in #9
• fix: log comments payload when getting an exception while adding review comments - a8ab3d5
• chore: deps upgrade - (1b4125c, b2eee5c, 0ebb301, df84a32, a0a923d)
• chore: add product hunt label in README - 6aa7b0b

What's Changed

• Updated Anthropic's default AI model version to claude-3-5-sonnet-20241022 - 4277ff8

Full Changelog: v2.0.0...v2.1.0

v2.0.0

Breaking Change

• fix: 🛠️ glob patterns input separator - from comma to semicolon by @murtuzaalisurti in #3 - d5e42cd

You must change the filesToIgnore glob patterns input to use semicolon as a separator and not comma as a separator.

Updates

• dependency updates - 5f5d63a, 03c477d
• sponsor banner - 29ad593
• better error handling for AI suggestions - c6d7a65

Full Changelog: v1...v2.0.0

v1.0.2

Updates

• modified action name - 421447f

Full Changelog: v1.0.0...v1.0.2

v1.0.1

Updates

• dependency updates - 6fa39ec

Full Changelog: v1.0.0...v1.0.1

v1.0.0

Introducing Better

A code reviewer github action powered by AI, ready to be used in your workflow. - by @murtuzaalisurti

Features

• Generate suggestions for PR changes using AI model of your choice.
• Suggestions include sample code and references to verified external sources.
• Supports industry leading platforms such as OpenAI and Anthropic.
• Supports custom AI models.
• Include custom rules for how the code should be.

Example workflow

name: Code Review
on:
    pull_request:
        types: [opened, reopened, synchronize, ready_for_review]
        branches:
            - main # change this to your target branch
    workflow_dispatch: # Allows you to run the workflow manually from the Actions tab

permissions: # necessary permissions
    pull-requests: write
    contents: read

jobs:
    your-job-name:
        runs-on: ubuntu-latest
        name: your-job-name
        steps:
            - name: step-name
              id: step-id
              uses: murtuzaalisurti/better@main # this is the ref of the github action - https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_iduses
              with:
                repo-token: ${{ secrets.GITHUB_TOKEN }} # this is auto generated
                ai-model-api-key: ${{ secrets.MODEL_API_KEY }} # make sure to set this in your repository secrets - /settings/secrets/actions (Settings > Secrets and Variables > Actions > Secrets Tab)
                platform: 'openai'
                delete-existing-review-by-bot: true #default is true
                filesToIgnore: '**/*.env, .husky/**' # uses glob patterns (micromatch - https://github.com/micromatch/micromatch)
                rules: |- # Rules to consider for code review
                    -- It must follow industry standard best practices
                    -- It should be idiomatic
                    -- It should be readable
                    -- It should not contain any security related vulnerabilities
                    -- It should not contain any sensitive data
                    -- It should be well structured
                    -- It should not contain bad patterns

Full Changelog: https://github.com/murtuzaalisurti/better/commits/v1.0.0