GitAuto AI

How to run GitAuto locally

3-1. Create your GitHub app for local development

1. Go to https://github.com/settings/apps
2. Click New GitHub App.
3. Fill in GitHub App name like GitAuto Dev {Your Name} e.g. GitAuto Dev John.
4. Fill in Homepage URL like http://localhost:8000.
5. Fill in Webhook URL with your Smee channel URL (e.g. https://smee.io/your-channel-id). GitHub requires HTTPS for the webhook URL. Smee.io is GitHub's recommended webhook proxy for local development - it forwards webhook payloads to your localhost via the smee-client. See section 3-3 for setup.
6. Fill in Webhook secret with your preferred secret.
7. Fill in Repository permissions
   • Actions: Read & Write
   • Checks: Read & Write
   • Commit statuses: Read & Write
   • Contents: Read & Write
   • Issues: Read & Write
   • Pull requests: Read & Write
   • Secrets: Read & Write
   • Variables: Read & Write
   • Workflows: Read & Write
8. Fill in Organization permissions
   • Members: Read-only
9. Fill in Subscribe to events
   • Installation target: Checked
   • Metadata: Checked
   • Check run: Checked
   • Commit comment: Checked
   • Issue comment: Checked
   • Issues: Checked
   • Pull request: Checked
   • Pull request review: Checked
   • Pull request review comment: Checked
   • Pull request review thread: Checked
   • Push: Checked
   • Status: Checked
10. Check Where can this GitHub App be installed? and select Only on this account.
11. Click Create GitHub App
12. Click Generate a private key and download the private key.

3-2. Install your GitHub app to a repository where you want to test

1. Go to GitHub Apps in the GitHub Developer Settings.
2. Choose your local GitHub app and go to the Install App page.
3. Install the app to the repository where you want to test.
4. Or directly go to https://github.com/settings/apps/{your-github-app-name}/installations such as https://github.com/settings/apps/gitauto-for-dev/installations.

3-3. Set up Smee.io webhook proxy

GitHub requires HTTPS for webhook events. We use Smee.io (GitHub's recommended webhook proxy) to forward webhook payloads to your localhost.

1. Go to https://smee.io and click Start a new channel.
2. Copy the channel URL (e.g. https://smee.io/abc123xyz).
3. Add SMEE_URL="https://smee.io/abc123xyz" to your .env file.
4. Set this same URL as the Webhook URL in your GitHub App settings (section 3-1, step 5).

Each developer gets their own unique Smee channel URL - no conflicts, no paid plans needed.

3-4. Managing Git branches

To update your local branch with the latest changes from our default branch (main), run the following commands:

git checkout your-branch
git pull origin main

For example:

git checkout wes
git pull origin main

If you have uncommitted changes, stash them first:

git stash        # Save changes
git pull origin main
git stash pop    # Reapply changes

3-5. Get the .env file

1. Ask for the .env file from @hiroshinishio.
2. Put the .env file in the root directory.

3-6. How to encode a GitHub app private key to base64

In .env file, you need to set your own GH_PRIVATE_KEY. Here's the step:

1. Go to https://github.com/settings/apps. Choose your local GitHub app.
2. Go to General tab on the left.
3. Scroll down to Private key section. Generate a private key.
4. Run base64 -i your/path/to/private-key.pem to encode the private key to base64.
5. Copy the output and paste it in the GH_PRIVATE_KEY field in your .env file.

3-7. How to run the code

1. Make the start script executable:

   chmod +x start.sh

2. Run the development environment:

   ./start.sh

This script will automatically:

• Create and activate virtual environment (if needed)
• Install dependencies (if needed)
• Start Smee.io webhook proxy (forwards GitHub webhooks to localhost)
• Start FastAPI server with visible logs
• Clean up both services when you press Ctrl+C

3-8. Success indicators

When everything is working correctly, you should see:

From start.sh:

• ✅ Virtual environment activation
• ✅ Smee.io webhook proxy started
• ✅ FastAPI server starting with logs below

FastAPI server:

• Server running on http://localhost:8000
• Watching for file changes (auto-reload enabled)
• No error messages during startup

If you see any errors, check:

• .env file is present and configured with SMEE_URL
• Port 8000 is not already in use

3-9. How to view AWS Lambda logs

When GitAuto runs in production, it uses AWS Lambda. To view logs and debug issues:

Using AWS CLI:

aws logs tail /aws/lambda/pr-agent-prod --follow | grep -v -E "(START RequestId|END RequestId|REPORT RequestId)" | sed -E 's/[0-9]{4}\/[0-9]{2}\/[0-9]{2}\/\[\$LATEST\][a-f0-9]+ //'

Using AWS Console:

1. Go to AWS CloudWatch Console
2. Navigate to Logs > Log groups
3. Find /aws/lambda/pr-agent-prod log group
4. Click on the latest log stream to view real-time logs
5. Use the filter box to exclude system messages: - "START RequestId" - "END RequestId" - "REPORT RequestId"

3-10. GitHub Actions Check Suite Architecture

Pull Request #123
└── Commit (sha: abc123)
    └── check_suite (GitHub Actions)
        ├── Workflow: "ci" (.github/workflows/ci.yml)
        │   ├── Job: build → check_run: "build"
        │   ├── Job: test → check_run: "test"
        │   └── Job: lint → check_run: "lint"
        └── Workflow: "deploy" (.github/workflows/deploy.yml)
            └── Job: deploy → check_run: "deploy"

For CircleCI hierarchy, see services/circleci/README.md.

3-11. Other information

For communication (Slack), database (Supabase), payment (Stripe), and serverless functions (AWS Lambda), provide your preferred email to @hiroshinishio so that he can invite you to the local development environment.