https://github.com/codota/tabnine-pr-agent

This repository contains the tabnine PR agent
https://github.com/codota/tabnine-pr-agent

Last synced: 2 months ago
JSON representation

This repository contains the tabnine PR agent

• Host: GitHub
• URL: https://github.com/codota/tabnine-pr-agent
• Owner: codota
• Created: 2024-07-31T14:49:08.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-20T10:03:56.000Z (over 1 year ago)
• Last Synced: 2025-01-04T15:42:12.051Z (about 1 year ago)
• Size: 17.6 KB
• Stars: 2
• Watchers: 10
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 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.

```yaml

on:

  pull_request:

    branches:

      - main

  

permissions:

  contents: read

  pull-requests: write

```

2. Ensure that repository is [checked out](https://github.com/actions/checkout/tree/v4#readme) within your workflow

3. Add the following to your workflow

```yaml

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: 

  # 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 }}

  

  # Only for selfhosted/EMT installation - selfhosted server URL. Example for EMT:"

  # selfhosted_url: "https://console.tabnine.com/"

```

# Examples

Full workflow that is triggered on "pull_request":

```yaml

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 }}

```