A tool to help creating PullRequests on Github easier and automate some of the steps
Assume you are on master branch and you make some changes but you want your changes to be code reviewd or for any other reason you want them in its own pull-request.
With prh
you can create a new branch, add the changed files, commit them, push the branch to origin, and create a pull-request from the new branch to your main branch with just one command:
prh -b my_new_branch
You can use prh in two main ways:
- create a pr from a new branch to current branch
prh -b <child_branch_name> [-a <file1_path> <file2_path> ...]
- create a pr from current branch to a different branch
prh -upto <parent_branch_name>
If you are using Pivotal Tracker, you can configure the prh_config.py file with your project id and api token and then all you need to do is to post a link to your story in the ```-m``` option along side of your commit message and prh will mark the story finished and link PR to the story.
Now you can install prh simply by using
brew tap kayvannj/prh
brew install prh
and you are good to go 🎉
In the first run, prh
is going to setup some configurations. The setup is also accessable from prh setup
command
brew unlink prh
brew install prh
https://www.pivotaltracker.com/help/articles/api_token/
Only repo permissions
usage: prh [-h] [-v] [--verbose [VERBOSE]] [-d [DEBUG]] [-s [STAY_ON]]
[-b [BRANCH]] [-sb [SUB_BRANCH]] [-pb [PR_BODY]] [-pt [PR_TITLE]]
[-a [ADD [ADD ...]]] [-e [EMPTY]] [-upto [UPTO]] [-sub [SUB]]
[-m [MESSAGE]] [-l [LOCAL]]
[setup]
positional arguments:
setup Setup the pull-request helper
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
--verbose [VERBOSE] run in verbose mode
-d [DEBUG], --debug [DEBUG]
run in debug mode
-s [STAY_ON], --stay_on [STAY_ON]
come back to current branch after all is done
-b [BRANCH], --branch [BRANCH]
Name of child branch
-sb [SUB_BRANCH], --sub_branch [SUB_BRANCH]
Name of child branch appended to the name of parent
branch
-pb [PR_BODY], --pr_body [PR_BODY]
Overwrite PullRequest Body text
-pt [PR_TITLE], --pr_title [PR_TITLE]
OverWrite PullRequest Title text
-a [ADD [ADD ...]], --add [ADD [ADD ...]]
Add files with given path, not using the option will
add all files
-e [EMPTY], --empty [EMPTY]
not making any commits or adds, just creates the PR
-upto [UPTO], --upto [UPTO]
Name of the parent branch that this PR should point to
-sub [SUB], --sub [SUB]
-m [MESSAGE], --message [MESSAGE]
Overwrite commit message or add a Pivotal Tracker
story link to fetch all the details from the story
-l [LOCAL], --local [LOCAL]
Do not push any changes or create a PR, only create
the branch and make the commit