GitHub PR Reporter

A Rust application that generates a report of GitHub pull requests for a specified repository and month. The report can be output in either a table or JSON format.

Installation

Install Rust

Please make sure you have Rust installed on your system

Clone the Repository:

git clone git@github.com:avantsoftware/Github-Reportifier.git

Navigate to the Project Directory:

cd github-pr-reporter

Build the Project:

cargo build --release

Move the binary to a directory in your PATH

sudo mv target/release/github-reportifier /usr/local/bin/

Configuration:

Create a .env file in the project root directory and add the following variables:

GITHUB_TOKEN=your_personal_access_token
REPO_OWNER=your_repo_owner
REPO_NAME=your_repo_name

Usage:

Run the application using cargo run with the desired options:

github-reportifier --month [OPTIONS]

Options:

--year, -y: The year for the report (default is the current year).
--month, -m: The month number (e.g., 9 for September). Required.
--output, -o: Output format: "table" or "json" (default is "table").

Examples:

Generate a Table Report for September 2023

github-reportifier --year 2023 --month 9

Generate a JSON Report for October 2024

github-reportifier --year 2024 --month 10 --output json

Output Formats:

• Table Output

By default, the report is displayed in a table format.

Sample Table Output:

• JSON Output

If you specify --output json, the report will be output in JSON format.

Sample JSON Output: