Project

ghreview

0.0
No commit activity in last 3 years
No release in over 3 years
ghreviewlslezak/ghreviewHomepageDocumentationSource CodeBug TrackerWiki
The 'ghreview' tool allows doing mass GitHub pull request reviews from command line. It is intended for approving simple changes is several pull requests even across several repositories.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
5,168
Stars
2
Forks
0
Watchers
3
 Releases
Current version
0.2.1
Total releases
3
First release
2020-03-30
Latest release
2020-04-06
 Issues
Open Issues
1
Closed Issues
0
Total Issues
1
Issue Closure Rate
0%
 Development
Primary Language
Ruby
Licenses
GPLv2
Average date of last 50 commits
2020-05-15
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 1.15.0, < 3.0
rake
~> 13
rubocop
= 0.71.0

Runtime

netrc
>= 0.11.0, < 1.0.0
octokit
>= 4.14.0, < 5.0.0
rainbow
>= 3.0.0, < 4.0.0
 Project Readme

ghreview - Mass GitHub Review from Command Line

Gem Version Rubocop

Sometimes you need to review a lot of pull requests with the same or very similar small change. Using the GitHub web UI is not convenient for approving many pull requests. That's the reason for creating the ghreview script which can be used from command line.

Features

  • Displays details of each pull request (title, diff)
  • Displays also the check results (CI like Travis, etc...) to avoid merging a pull request which does not pass checks
  • It can approve each pull request with the default "LGTM" message (Looks Good To Me), but you can use a custom message, see the options below
  • Optionally can merge the pull requests and delete the source branch
  • The pull requests can be passed as arguments or they can be read from a file

If a pull request is not approved then it is skipped and not touched at all. You need to comment at the GitHub pull request page manually in that case.

Usage

Just pass the list of the pull request URLs as the script arguments, for example:

ghreview --merge https://github.com/yast/yast-users/pull/218 \
  https://github.com/yast/yast-firstboot/pull/76 \
  https://github.com/yast/yast-add-on/pull/84 \
  https://github.com/yast/yast-sysconfig/pull/29 \
  https://github.com/yast/yast-sound/pull/35

Or use the --file option to read them from a file.

Installation

The script is packaged as a Ruby gem, to install it run:

gem install ghreview

Alternatively you can run it directly from the GitHub sources:

git clone https://github.com/lslezak/ghreview.git
cd ghreview
bundle install --path vendor/bundle --without development
bundle exec bin/ghreview ...

Authentication

You need to create a GitHub access token to enable GitHub access from scripts.

Using .netrc File

You can store the generated token into the ~/.netrc file, see the this documentation for more details.

Just make sure the .netrc file is not readable for the other users (chmod 0600 ~/.netrc).

Passing via Environment

Alternatively the access token can be passed via environment variable GH_TOKEN:

␣GH_TOKEN=... ghreview ...

⚠️ Note the extra space at the beginning of the line, that is required to avoid storing the command with the token into the shell history file (like ~/.bash_history).

Options

The script accepts these optional command line options:

  • --merge (or -g) - Merge the pull request after approving it
  • --delete (or -d) - Delete the source branch after merging (the YaST GitHub repositories have now enabled the auto-removal of the merged branches so this option is usually not needed)
  • --message <message> (or -m <message>) - The text used in the review comment, the default is LGTM (Looks Good To Me)
  • --file <file> (or -f <file>) - Read the list of pull requests from a file (one pull request per line)