get-gh-reviews

📝 Track GitHub reviews you have received on your pull requests

Overview

get-gh-reviews is a CLI tool and npm package written in TypeScript that helps developers track the feedback they receive during code review. It addresses the GitHub feature gap where there's no consolidated view of all reviews you've received on your pull requests.

Features

• ✅ List all reviews received on your pull requests
• 📊 Statistics and insights about your review activity
• 🏢 Organization filtering for enterprise/team workflows
• ⏱️ Time-based filtering (reviews from last N days)
• 🎯 Multiple output formats (human-readable, JSON, and Markdown)
• 📝 Markdown report generation with clickable PR links
• 🔍 Detailed review information including comments and states

Installation

Global Installation (CLI usage)

npm install -g get-gh-reviews

Local Installation (as dependency)

npm install get-gh-reviews

Setup

You'll need a GitHub Personal Access Token with appropriate permissions:

1. Go to GitHub Settings > Developer settings > Personal access tokens
2. Generate a new token with these scopes:
   • repo (for private repositories)
   • public_repo (for public repositories)
3. Set the token as an environment variable:

export GITHUB_TOKEN="your_token_here"

Or create a .env file:

echo "GITHUB_TOKEN=your_token_here" > .env

CLI Usage

Get Reviews Received

# Basic usage
get-gh-reviews reviews -u your-username

# Filter by organization
get-gh-reviews reviews -u your-username -o your-org

# Filter by time (last 30 days)
get-gh-reviews reviews -u your-username -d 30

# Filter by PR state
get-gh-reviews reviews -u your-username -s open

# JSON output
get-gh-reviews reviews -u your-username --json

# Markdown file output
get-gh-reviews reviews -u your-username --markdown my-reviews

# With custom token
get-gh-reviews reviews -u your-username -t your_token_here

Get Review Statistics

# Basic stats
get-gh-reviews stats -u your-username

# Organization stats
get-gh-reviews stats -u your-username -o your-org

# Last 7 days stats
get-gh-reviews stats -u your-username -d 7

# JSON output
get-gh-reviews stats -u your-username --json

CLI Options

Programmatic Usage

JavaScript/Node.js

const { GitHubReviewsTracker } = require('get-gh-reviews');

const tracker = new GitHubReviewsTracker('your_github_token');

TypeScript

import { GitHubReviewsTracker, Review, ReviewStats } from 'get-gh-reviews';

const tracker = new GitHubReviewsTracker('your_github_token');

// Get reviews received
async function getMyReviews() {
  try {
    const result = await tracker.getReceivedReviews('your-username', {
      state: 'all',
      per_page: 30,
      org: 'your-org',        // optional
      timeframe: 7            // last 7 days, optional
    });
    
    console.log(`Found ${result.total_count} reviews`);
    result.reviews.forEach(review => {
      console.log(`${review.reviewer}: ${review.state} on ${review.pr_title}`);
    });
  } catch (error) {
    console.error('Error:', error.message);
  }
}

// Get review statistics
async function getMyStats() {
  try {
    const stats = await tracker.getReviewStats('your-username', {
      org: 'your-org',        // optional
      timeframe: 30           // last 30 days, optional
    });
    
    console.log('Review Stats:', stats);
  } catch (error) {
    console.error('Error:', error.message);
  }
}

// Generate Markdown report
async function generateReport() {
  try {
    const result = await tracker.getReceivedReviews('your-username', {
      timeframe: 30
    });
    
    const markdownContent = tracker.generateMarkdownReport(result.reviews, 'your-username', {
      title: 'Monthly Review Report',
      includeStats: true
    });
    
    const fs = require('fs');
    fs.writeFileSync('my-reviews.md', markdownContent, 'utf8');
    console.log('Markdown report generated: my-reviews.md');
  } catch (error) {
    console.error('Error:', error.message);
  }
}

getMyReviews();
getMyStats();
generateReport();

Markdown Report Example

When using --markdown option, the generated report includes:

# 受け取ったレビュー レポート

**生成日:** 2025/1/15
**対象ユーザー:** your-username  
**レビュー総数:** 15件

## 📊 統計情報

- ✅ 承認済み: 8件
- 🔄 変更要求: 5件  
- 💬 コメントのみ: 2件

## 📝 レビュー一覧

### [Add user authentication system](https://github.com/company/web-app/pull/123) (#123)

**リポジトリ:** company/web-app

#### ✅ APPROVED by [@senior-dev](https://github.com/senior-dev)

**日時:** 2025/1/15 14:30:00
**コメント:**
> Great implementation! The security considerations are well thought out.

**[レビューを表示](https://github.com/company/web-app/pull/123#pullrequestreview-123456)**

---

API Response Format

Reviews Response

{
  "reviews": [
    {
      "pr_title": "Add new feature X",
      "pr_number": 123,
      "pr_url": "https://github.com/owner/repo/pull/123",
      "repository": "owner/repo",
      "reviewer": "reviewer-username",
      "reviewer_avatar": "https://avatars.githubusercontent.com/u/123456?v=4",
      "state": "APPROVED",
      "submitted_at": "2025-01-15T10:30:00Z",
      "body": "Looks good to me!",
      "review_url": "https://github.com/owner/repo/pull/123#pullrequestreview-123456"
    }
  ],
  "total_count": 42,
  "page": 1,
  "per_page": 30
}

Statistics Response

{
  "total_reviews": 42,
  "by_state": {
    "approved": 25,
    "changes_requested": 12,
    "commented": 5
  },
  "by_reviewer": {
    "reviewer1": 15,
    "reviewer2": 10,
    "reviewer3": 8
  },
  "by_repository": {
    "org/repo1": 20,
    "org/repo2": 15,
    "org/repo3": 7
  }
}

Review States

• APPROVED ✅ - Review approved the pull request
• CHANGES_REQUESTED 🔄 - Review requested changes
• COMMENTED 💬 - Review left comments without explicit approval
• DISMISSED ❌ - Review was dismissed

Use Cases

Individual Developers

• Track feedback patterns to improve code quality
• Identify frequent reviewers and build better relationships
• Monitor review response times and engagement

Team Leaders

• Analyze review distribution across team members
• Identify knowledge sharing opportunities
• Monitor review quality and engagement

Organizations

• Track review activity across repositories
• Identify review bottlenecks and patterns
• Generate reports for development process improvement

Development

This package is written in TypeScript. For development:

# Run TypeScript CLI directly
npm run dev -- reviews -u username

# Build the project
npm run build

# Run example
npm run example

Requirements

• Node.js 14.0.0 or higher
• GitHub Personal Access Token
• Network access to GitHub API

Rate Limiting

This tool respects GitHub's API rate limits. For authenticated requests:

• 5,000 requests per hour for personal access tokens
• The tool includes built-in retry logic and rate limit handling

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

Issues and Feature Requests

Found a bug or have a feature request? Please open an issue on the GitHub repository.

License

ISC License - see the LICENSE file for details.

Related

This package addresses the GitHub feature request for tracking reviews received, which is currently not available in the GitHub web interface. It complements existing features like "Reviews requested" and "Reviews given".