New:

• Exclude Gerrit changes with no reviewers invited
• Refactoring all tests & Tox support
• Phabricator support (check examples/sampleinput_phabricator.yaml )
• Possibility of omitting WIP pull requests/merge requests in output with --ignore-wip argument
• Replace -s, -v, -d arguments with one argument --age

review-rot

reviewrot is a CLI tool, that helps to list down open review requests from github, gitlab, pagure, gerrit and phabricator.

Sample I/P:

Create '~/.reviewrot.yaml'. browse the examples for content.

Installation

python setup.py install

Alternatively, for development:

python setup.py develop

[NEW] Tests

You can use tox or detox to run the tests against Python 3.7+:

sudo dnf install python-detox
detox

Script:

review-rot

> review-rot --help
usage: review-rot [-h] [-c CONFIG]
                  [--age {older,newer} [#y #m #d #h #min ...]]
                  [-f {oneline,indented,json}] [--show-last-comment [DAYS]]
                  [--reverse] [--sort {submitted,updated,commented}] [--debug]
                  [--email EMAIL [EMAIL ...]] [--subject SUBJECT]
                  [--irc CHANNEL [CHANNEL ...]] [--ignore-wip] [-k]
                  [--cacert CACERT]

Lists pull/merge/change requests for github, gitlab, pagure, gerrit and
phabricator

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Configuration file to use
  --age {older,newer} [#y #m #d #h #min ...]
                        Filter pull request based on their relative age
  -f {oneline,indented,json}, --format {oneline,indented,json}
                        Choose from one of a few different styles
  --show-last-comment [DAYS]
                        Show text of last comment and filter out pull requests
                        in which last comments are newer than specified number
                        of days
  --reverse             Display results with the most recent first
  --sort {submitted,updated,commented}
                        Display results sorted by the chosen event time.
                        Defaults to submitted
  --debug               Display debug logs on console
  --email EMAIL [EMAIL ...]
                        send output to list of email adresses
  --subject SUBJECT     Email subject text.
  --irc CHANNEL [CHANNEL ...]
                        send output to list of irc channels
  --ignore-wip          Omit WIP PRs/MRs from output

SSL:
  -k, --insecure        Disable SSL certificate verification (not recommended)
  --cacert CACERT       Path to CA certificate to use for SSL certificate
                        verification

You can filter MRs/PRs based on their relative age

review-rot --age older 5d 10h

outputs MRs/PRs which were submitted more than 5 days and 10 hours ago

review-rot --age newer 5d 10h

outputs MRs/PRs which submitted in the last 5 days and 10 hours

You can use --show-last-comment flag to include the text of last comment with formats:

• json

  review-rot -f json --show-last-comment

• email

  review-rot --email user@example.com --show-last-comment

Web UI

There is a static html+js web interface that can read in the output of the review-rot CLI tool and produce a web page:

First, set up a cron job to run review-rot every (say) 15 minutes:

*/15 * * * * review-rot -f json > /home/someuser/public_html/reviewrot/data.json

Then, modify web/js/site.js to point the data url to the location of your new file.

Email notification

To use email notification functionality you must specify mailer configuration in config file

mailer:
  sender: do-not-reply@example.com
  server: smtp.example.com

then specify email addresses in config file:

arguments:
  email: user1@example.com, user2@example.com

Or in command line:

review-rot --email user1@example.com user2@example.com

IRC notification

To use irc notification functionality you must specify irc server configuration in config file

irc:
  server: irc.example.com
  port: 12345

then specify channels in config file for example:

arguments:
  # don't forget to use quotes
  irc: '#channel1, #channel2'

Or in command line:

# don't forget to use quotes or backslash
review-rot --irc '#channel1' '#channel2'
review-rot --irc \#channel1 \#channel2

Gerrit service

[NEW] Exclude changes with no reviewers invited:

git_services:
  - type: gerrit
    reviewers:
      ensure: True

User accounts can be excluded from the reviewers list for the change, for example, to not count bot accounts as reviewers:

git_services:
  - type: gerrit
    reviewers:
      id_key: email
      excluded:
        - the.bot@example.com

id_key is the FieldName to get the value to identify the reviewer. If not set defaults to username.

excluded is a list of reviewers, identified by their id_key in the reviewers entity.

If reviewers is not empty and ensure is not defined, it's implicitly True.

ID values for excluded and id_key are the same as for AccountInfo.