Prerequisite: Callstack account is required for reviewer to work. Create account here

Managed Service

PR Reviewer can be run as a managed service by Callstack.ai. This service is fully managed by Callstack and requires no setup on your end other than installing the GitHub App and creating a Callstack account. For each review, we create a branch new instance where your codebase is cloned and analyzed. Managed instance represents a hardened environment that does not mount any persistent storage, all data is present only in memory and is destroyed immediately after the review is done.

Self-Service

You can run PR Reviewer directly in your GitHub Actions workflow by including the file below in your .github/workflows directory. Callstack.ai will receive webhooks from GitHub Actions and start the review process automatically.

.github/workflows/callstack-reviewer.yml
name: Callstack.ai PR Review

on:
  workflow_dispatch:
    inputs:
      config:
        type: string
        description: "config for reviewer"
        required: true
      head:
        type: string
        description: "head commit sha"
        required: true

jobs:
  callstack_pr_review_job:
    runs-on: ubuntu-latest
    steps:
      - name: Review PR
        uses: callstackai/action@main
        with:
          config: ${{ inputs.config }}
          head: ${{ inputs.head }}