README.md

Prst

prst is a Pull Request Status Tracker. Run it in on your branch and it will display live all the status checks of the relevant pull request.

Once all the checks passed, it will notify you and open the Pull Request in your browser.

Installation

Install globally through yarn:

yarn global add prst

You also need a GITHUB_TOKEN environment variable with a valid personal access token. You can create one on https://github.com/settings/tokens and give it the repo and workflow scopes.

If your organization has SSO enabled, you'll need to sign your token by clicking on the Enable SSO button

Usage

Run prst from your git repository and it will automatically look for a Pull Request coming from your current branch and display the relevant status check.

It will check for status update and once the build is over, will notify you through your OS notification system and open the Pull Request in your browser.

Notification system

prst do use growl as notification system

If you are on MacOS, you need to install it with :

sudo gem install terminal-notifier
npm install growl

Options

prst will look for a remote branch with the same name as the local branch by default, but you can specify your own branch by pass the --branch argument.

By default the process will run until all the checks are completed, but you can pass the --once flag to run it once and stop.

Add the --debug flag to see more debug information, like your current API rate limit credentials.

Status are polled every 5mn by default, but you can pass the --interval flag to define your own custom interval delay (in seconds).