How to install the pr-summary crate // Lib.rs

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install pr-summary

It will make the pr-summary command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall pr-summary uninstalls.

Back to the crate overview.

Readme

A quick-and-dirty tool to generate a markdown table that summarizes the status (conflicts, CI, review state) of PRs

PR	Author	Mergeable	Review state
#912 🔴	sdbondi	No	Needs review
#911 🔴	sdbondi	No	Needs review
#893 🔴	mrx	Conflicts	Approved by sdbondi
#895 🟢	x	Conflicts	Dismissed

Permissions

Head to https://github.com/settings/tokens?type=beta
Setup these permissions
Set GITHUB_TOKEN to your personal token, or pass in --token github_xxxx on the command line

Command options

Usage: pr-summary --owner <OWNER> --repo <REPO> --personal-token <PERSONAL_TOKEN>

Options:
  -o, --owner <OWNER>                    
  -r, --repo <REPO>                      
  -t, --personal-token <PERSONAL_TOKEN>  [env: GITHUB_TOKEN]
  -h, --help                             Print help