​

GitHub Integration Guide

​

Overview

1. Fetch pull request data and link it to commits
2. Retrieve issue information and connect it to related PRs
3. Capture discussions and comments
4. Track code reviews and feedback
5. Analyze contribution patterns

​

Authentication

​

Using a Personal Access Token (PAT)

1. Create a token:
   • Go to GitHub Settings > Developer settings > Personal access tokens
   • Click “Generate new token”
   • Select the following scopes:
     • repo (for private repositories)
     • read:user
     • read:org (if accessing organization repositories)
   • Click “Generate token”
   • Copy the token
2. Authenticate with Arc Memory:
   Copy

   arc auth gh --token YOUR_TOKEN
   

3. Verify authentication:
   Copy

   arc auth status
   

​

Using GitHub CLI

# First, ensure you're logged in with GitHub CLI
gh auth login

# Then, use GitHub CLI auth with Arc Memory
arc auth gh --use-gh-cli

​

Using a GitHub App (for Organizations)

1. Create a GitHub App:
   • Go to GitHub Settings > Developer settings > GitHub Apps
   • Click “New GitHub App”
   • Fill in the required information
   • Set permissions:
     • Repository: Read-only
     • Issues: Read-only
     • Pull requests: Read-only
     • Discussions: Read-only
   • Create the app
2. Install the app on your organization or repositories
3. Generate a private key for the app
4. Authenticate with Arc Memory:
   Copy

   arc auth gh-app --app-id YOUR_APP_ID --installation-id YOUR_INSTALLATION_ID --private-key-path path/to/private-key.pem
   

​

Building with GitHub Data

# Build with GitHub data
arc build --include-github

# Or build incrementally
arc build --incremental --include-github

​

Limiting GitHub Data

# Limit to recent PRs and issues
arc build --include-github --days 30

# Limit to specific PR numbers
arc build --include-github --prs 123,456,789

# Limit to specific issue numbers
arc build --include-github --issues 100,200,300

​

GitHub Data in the Knowledge Graph

​

Node Types

​

Edge Types

​

Querying GitHub Data

​

Finding PRs for a Commit

arc relate node commit:abc123 --node-types PR

​

Finding Issues Referenced by a PR

arc relate node pr:123 --edge-types REFERENCES

​

Finding the Decision Trail for a Line

arc why file path/to/file.py 42 --include-prs --include-issues

​

GitHub Enterprise Support

# Authenticate with GitHub Enterprise
arc auth gh --token YOUR_TOKEN --api-url https://github.your-company.com/api/v3

​

Rate Limiting Considerations

• Authenticated requests: 5,000 requests per hour
• Unauthenticated requests: 60 requests per hour

1. Always authenticate with a token
2. Use incremental builds when possible
3. Limit the scope of your builds
4. Consider using a GitHub App for higher rate limits

​

Troubleshooting

​

Authentication Issues

1. Verify your token has the correct scopes
2. Check if the token has expired
3. Try re-authenticating:
   Copy

   arc auth gh --token YOUR_NEW_TOKEN
   

​

Rate Limit Errors

1. Check your current rate limit status:
   Copy

   curl -H "Authorization: token YOUR_TOKEN" https://api.github.com/rate_limit
   

2. Wait for the rate limit to reset
3. Use incremental builds:
   Copy

   arc build --incremental --include-github
   

4. Limit the scope of your build:
   Copy

   arc build --include-github --days 7
   

​

Missing Data

1. Verify you included the GitHub flag:
   Copy

   arc build --include-github
   

2. Check if the data exists on GitHub
3. Verify your authentication has access to the repository
4. Run with debug logging:
   Copy

   arc build --include-github --debug
   

​

Best Practices

1. Use incremental builds to minimize API calls
2. Authenticate with a token to increase rate limits
3. Limit the scope of your builds to recent data when possible
4. Consider using a GitHub App for organization-wide use
5. Schedule builds during off-hours for large repositories
6. Use specific filters when querying to improve performance

​

Examples

​

CI/CD Integration

# Example GitHub Actions workflow
name: Arc Memory Build

on:
  schedule:
    - cron: '0 0 * * *'  # Daily at midnight
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'
      
      - name: Install Arc Memory
        run: pip install arc-memory
      
      - name: Build knowledge graph
        run: |
          arc auth gh --token ${{ secrets.GITHUB_TOKEN }}
          arc build --include-github --incremental
      
      - name: Upload database
        uses: actions/upload-artifact@v3
        with:
          name: arc-memory-db
          path: .arc/memory.db

​

Team Dashboard Integration

from arc_memory import ArcMemory
import pandas as pd
import matplotlib.pyplot as plt

# Initialize Arc Memory
arc = ArcMemory()

# Query PR data
prs = arc.query_prs(days=30)

# Create a DataFrame
pr_data = pd.DataFrame([
    {
        'PR': pr.number,
        'Author': pr.author,
        'Created': pr.created_at,
        'Merged': pr.merged_at,
        'Comments': len(pr.comments),
        'Files Changed': len(pr.files),
        'Additions': pr.additions,
        'Deletions': pr.deletions
    }
    for pr in prs
])

# Generate visualizations
plt.figure(figsize=(12, 6))
pr_data.groupby('Author').size().plot(kind='bar')
plt.title('PRs by Author (Last 30 Days)')
plt.savefig('prs_by_author.png')

​

See Also

• Authentication Command - For more authentication options
• Build Command - For more build options
• Dependencies Guide - For required dependencies
• Troubleshooting Guide - For common issues and solutions