pra is a command line tool designed to allow developers to see the
current state of open pull-requests across multiple services. Currently, it
supports the following services:
You can easily install pra with the following command:
$ gem install pra
pra requires one configuration, ~/.pra.json, to exist in your home
directory. The following is an example config that can be used as a starter.
Note: You will need to replace your.username, your.password,
your.stash.server, and the repositories sections of each of the pull
sources.
{
"pull_sources": [
{
"type": "stash",
"config": {
"protocol": "https",
"host": "your.stash.server",
"username": "your.username",
"password": "your.password",
"repositories": [
{ "project_slug": "CAP", "repository_slug": "capture_api" },
{ "project_slug": "RELENG", "repository_slug": "ramboo" }
]
}
},
{
"type": "github",
"config": {
"protocol": "https",
"host": "api.github.com",
"username": "your.username",
"password": "your.password",
"repositories": [
{ "owner": "reachlocal", "repository": "snapdragon" },
{ "owner": "brewster", "repository": "cequel" }
]
}
}
]
}
I suggest copying and pasting the above starter file into your ~/.pra.json
file to get you started. Then simply replace the appropriate fields and the
repositories sections for all the pull sources with the repository
information for the repositories you want to watch for open pull requests.
Sadly, at the moment pra doesn't support GitHub's Multi-Factor
Authentication. There is a ticket for this
( #5 ).
It is also lacking support for GitHub's OAuth mechanism. There is a ticket for this ( #6 ).
The HTTP Basic Auth will work as long as you don't have multi-factor authentication enabled for your account.
Personal Access Token authentication is currently supported and this is the recommended authentication mechanism to use right now. It is the only authentication mechanism you can use at the moment if you have multi-factor authentication enabled.
Simply go to your GitHub Account Settings, select Applications, click
the Create new token button in the Personal Access Token section. Give
it the name "Pra" and submit. This will generate your personal access token.
Then simply put your personal access token in the ~/.pra.json as your GitHub
username and "x-oauth-basic" as your GitHub password.
Once you have configured pra as described above you can launch it by simply
running the following command:
pra
Once it launches, it will use the information provided in the ~/.pra.json
configuration file to fetch all the open pull requests and display them. Once,
the pull requests are displayed you can perorm any of the following actions.
To move the selection up simply press either the k or the up arrow key.
To move the selection down simply press either the j or down arrow key.
If you would like to open the currently selected pull request in your default
browser you can press either the o or enter key.
If you decide you have had enough and want to exit pra press the q key.
If you would like to contribute to the pra project. You can do so in the
following areas:
As with all software I am sure pra will have some bugs. I would very much
appreciate any contributions of bug reports. These can be reported on the
issues page of the project.
The current state of pra is just the MVP (minimum viable product). This
means there is always room for growth. If you would like to contribute your
thoughts on features that you would like pra to have you can submit them on
the issues page of the project.
If you would like to contribute documentation improvements you should follow the directions below.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
If you want to contribute by writing code for pra you need to know the
following:
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
We use RVM with pra to encapsulate the dependency gems in our
development environments. Therefore, we have the .ruby-version and
.ruby-gemset files in the repository which define the current version of
ruby and the gemset that we are developing with.
You should have RVM installed of course and when you change into the project root directory it should switch to the proper ruby version if you have it intsalled via RVM. It should also create and switch to the proper gemset.
If the proper version of ruby is NOT installed via RVM you should first install that version of ruby and then change out of the project root directory, then change back into it and verify that you are in the proper ruby version and gemset. This can be done with the following command.
rvm current
The above command should have output the following
ruby-2.0.0-p247@pra
We use Bundler to manage the development dependencies of
pra. Once you got setup with RVM as described above you
should be able to install all the development dependencies using the following
command:
bundle
I eveloped pra using the TDD methodology with
RSpec as the testing tool of choice.
Therefore, if you are going to contribute code to pra please TDD your code
changes using RSpec. If you do not submit
your changes with test coverage your request will likely be denied requesting
you add appropriate test coverage.
If you have setup RVM as described above and installed the
development dependencies using Bundler as described
above you should be able to run the development version of pra by running
the following command:
./bin/pra
Note: The above of course assumes that you have a ~/.pra.json file
already configured.