Tabnine PR Agent V1

This action analyzes a pull request using the TabNine CLI. It pulls the necessary Docker image, runs an analysis on the pull request, and checks the report in watch mode. This action helps in automating the code review process by leveraging TabNine's AI-powered code analysis capabilities.

Usage

1. This action works only on the "pull_request" event within the workflow.

on:
  pull_request:
    branches:
      - main
  
permissions:
  contents: read
  pull-requests: write

2. Ensure that repository is checked out within your workflow
3. Add the following to your workflow

uses: codota/tabnine-pr-agent@v1
continue-on-error: true
with:
  # Personal Access Token (PAT) issued by the admin to access TabNine's analyzing capabilities
  PAT: <INSERT_YOUR_PAT_HERE>

  # The source branch of the pull request
  ref: origin/${{ github.head_ref }}
  
  # The target branch (destination) of the pull request
  base_ref: origin/${{ github.base_ref }}

  # Path to the repository in the workflow run, typically equal to "github.workspace"
  path_to_repo: ${{ github.workspace }}

  # GitHub username or organization name that owns the repository
  repository_owner: ${{ github.repository_owner }}

  # The name of the GitHub repository
  repository_name: ${{ github.event.repository.name }}
  
  # The ID of the pull request
  pull_request_id: ${{ github.event.pull_request.number }}

  # GitHub token for authentication, provided by GitHub when the workflow is run
  github_token: ${{ secrets.GITHUB_TOKEN }}

Examples

Full workflow that is triggered on "pull_request":

name: "Tabnine PR review agent"

on:
  pull_request:
    branches:
      - main
        
permissions:
  contents: read
  pull-requests: write

jobs:
  review_pr:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Review PR
        uses: codota/tabnine-pr-agent@v1
        continue-on-error: true
        with:
          PAT: ${{ secrets.COACHING_PAT }}
          ref: origin/${{ github.head_ref }}
          base_ref: origin/${{ github.base_ref }}
          path_to_repo: ${{ github.workspace }}
          repository_owner: ${{ github.repository_owner }}
          repository_name: ${{ github.event.repository.name }}
          pull_request_id: ${{ github.event.pull_request.number }}
          github_token: ${{ secrets.GITHUB_TOKEN }}