https://github.com/pixelastic/prst
Pull Request Status Tracker. See your PR status live from your commandline, and get notified when all tests are done.
https://github.com/pixelastic/prst
Last synced: over 1 year ago
JSON representation
Pull Request Status Tracker. See your PR status live from your commandline, and get notified when all tests are done.
- Host: GitHub
- URL: https://github.com/pixelastic/prst
- Owner: pixelastic
- License: mit
- Created: 2020-10-30T10:17:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-26T12:50:19.000Z (over 1 year ago)
- Last Synced: 2025-02-26T13:43:05.719Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/prst
- Size: 1.47 MB
- Stars: 5
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Prst
`prst` is a **P**ull **R**equest **S**tatus **T**racker. Run it in on your
branch and it will display live all the status checks of the relevant pull
request.
![prst in action][1]
Once all the checks passed, it will notify you and open the Pull Request in your
browser.
## Installation
Install globally through yarn:
```javascript
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][2] 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][3] 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).
[1]: https://raw.githubusercontent.com/pixelastic/prst/master/.github/screenshot.png
[2]: https://github.com/settings/tokens
[3]: https://classic.yarnpkg.com/en/package/growl