Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caarlos0-graveyard/zsh-open-pr
Open pull requests from the command line.
https://github.com/caarlos0-graveyard/zsh-open-pr
Last synced: 9 days ago
JSON representation
Open pull requests from the command line.
- Host: GitHub
- URL: https://github.com/caarlos0-graveyard/zsh-open-pr
- Owner: caarlos0-graveyard
- License: mit
- Created: 2014-12-30T01:37:29.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-06-15T02:09:19.000Z (over 2 years ago)
- Last Synced: 2024-05-21T13:51:29.273Z (6 months ago)
- Language: Shell
- Homepage:
- Size: 1.3 MB
- Stars: 65
- Watchers: 2
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
open-pr [](https://travis-ci.org/caarlos0/zsh-open-pr)
==================
Open pull requests from command line.
## What it does
Basically, when you call `git open-pr`, the function will verify if you are working
on a fork (by convention, you have an `upstream` remote), then, it will open
your browser in the correct URL so you can just hit the `Create Pull Request`
button.
The function also accepts one argument, in case you want to specify another
target branch (instead of master, which is the convention).
URL breakdown:
```
https://github.com/target-remote/repo/compare/master...origin:random-feature
| | | | | | | |
| | | | | | | -> the branch
| | | | | | | you want
| | | | | | | to submit
| | | | | | |
| | | | | | -> will appear only
| | | | | | if you are
| | | | | | working in a fork
| | | | | |
| | | | | -> default GitHub compare
| | | | | thing
| | | | |
| | | | -> target branch
| | | |
| | | -> default GitHub endpoint to open a PR
| | |
| | -> the target repository, also from origin
| | or upstream remotes
| |
| -> can be both origin or upstream
|
-> default host
```
## Usage
For example, when you work on your own project:
```console
$ git remote -v
origin [email protected]:caarlos0/open-pr.git (fetch)
origin [email protected]:caarlos0/open-pr.git (push)
$ git branch
* master
$ git checkout -b random-feature
$ touch this-file-is-important
$ git add -A
$ git commit -m 'did some stuff'
$ git push
$ git open-pr
# will browse https://github.com/caarlos0/open-pr/compare/master...random-feature
```
Working on a fork:
```console
$ git remote -v
origin [email protected]:random-user/open-pr.git (fetch)
origin [email protected]:random-user/open-pr.git (push)
upstream [email protected]:caarlos0/open-pr.git (fetch)
upstream [email protected]:caarlos0/open-pr.git (push)
$ git branch
* master
$ git checkout -b random-feature
$ touch this-file-is-important
$ git add -A
$ git commit -m 'did some stuff'
$ git push
$ git open-pr
# will browse https://github.com/caarlos0/open-pr/compare/master...random-user:random-feature
```
Previous example, but to a `develop` branch, for instance:
```console
$ git open-pr develop
# will browse https://github.com/caarlos0/open-pr/compare/develop...random-user:random-feature
```
## Install using [antibody](http://getantibody.github.io/)
```console
$ antibody bundle caarlos0/open-pr kind:path
```
## Install using [Fig](https://fig.io)
Fig adds apps, shortcuts, and autocomplete to your existing terminal.
Install `zsh-open-pr` in just one click.
## Usage
Just hit `git open-pr` on your repositories.
You can also alias it:
```console
$ git config --global alias.pr open-pr
$ git pr
```
But I like the following approach more:
```console
gpr() {
git push origin HEAD && git open-pr "$@"
}
```
So I can `git push` and `git open-pr` in a single, three letters command:
```console
$ gpr
```
## Contributing
The project is linted with Shellcheck and have unit tests. Please, take a look
at them and execute `./build.sh` to make sure it all works well. :beers: