Skip to main content

Command line tool to send GitHub pull requests

Project description

Build Status https://badge.fury.io/py/git-pull-request.svg

git-pull-request is a command line tool to send GitHub or Pagure pull-request from your terminal.

Installation

Use the standard Python installation method:

pip3 install git-pull-request

Although it might not be up to date with the latest code on GitHub Fedora 28+ users can also download straight via package manager DNF:

sudo dnf install git-pull-request

Usage

Once you’ve made your commits into a branch, just type:

git pull-request

This will:

  1. Fork the upstream repository into your account (if needed)

  2. Add your forked repository as a remote named “github” (if needed)

  3. Force push your current branch to your remote

  4. Create a pull-request for your current branch to the remote matching branch, or master by default.

If you add more commits to your branch later, or need to rebase your branch to edit commits, you’ll just need to run git pull-request to update your pull-request. git-pull-request automatically detects that a pull-request has been opened for your current working branch.

Workflow advice

Caching Credentials

GitHub has a good documentation about using git credential.

The full documentation is available on the git-scm.com website.

Pagure Token

Pagure uses API key, you need to create one by visiting your settings and requesting the Fork a project and Modify an existing project ACL.

Creating Branches

When sending pull-requests, it’s preferable to do so from your own branch. You can create your own branch from master by doing:

$ git checkout -b myownbranch --track origin/master

This will checkout a new branch called myownbranch that is a copy of master. Using the –track option makes sure that the upstream source branch is written in your .git/config file. This will allow git-pull-request to know to which branch send the pull-request.

Since this is long to type, you can use an alias in git to make it faster:

$ git config --global alias.nb '!git checkout --track $(git config branch.$(git rev-parse --abbrev-ref HEAD).remote)/$(git rev-parse --abbrev-ref HEAD) -b'

This will create a git nb alias that will create a new branch tracking the current branch and checking it out. You can then use it like that:

$ git nb foobar
Branch foobar set up to track remote branch master from origin.
Switched to a new branch 'foobar'

Configuration via git config

Most git-pull-request command line arguments can be store into your git configuration.

For a particular repository, if you get tired of using:

$ git pull-request --fork never

You can set the option with git and use the command without any arguments:

$ git config git-pull-request.fork never
$ git pull-request

You can also set the option globally to have a custom default for all your repositories with:

$ git config --global git-pull-request.fork always
$ git pull-request

Difference with hub

The wrapper hub provides hub fork and hub pull-request as command line tools to fork and create pull-requests.

Unfortunately, it’s hard to combine these tools in an automated implementation for a complete workflow.

For example: If you need to update your pull-request, there’s no way to identify existing pull requests, so calling hub pull-request would just open a new pull-request.

git-pull-request wraps all of these operations into one convenient tool.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git-pull-request-5.0.1.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

git_pull_request-5.0.1-py2.py3-none-any.whl (21.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file git-pull-request-5.0.1.tar.gz.

File metadata

  • Download URL: git-pull-request-5.0.1.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.8

File hashes

Hashes for git-pull-request-5.0.1.tar.gz
Algorithm Hash digest
SHA256 cd1ec100413e159d82814bf38a3409357f5e5e8c0463aab20ea79be246daaaa0
MD5 1b040edff1412cdd119b59f33f56f03b
BLAKE2b-256 2bbf889a3ca32fc7221ed929bcd79a6d6e10478b493a435ec7f1bbd6b5278222

See more details on using hashes here.

File details

Details for the file git_pull_request-5.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for git_pull_request-5.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 97658717611fe760d94a7ab1b9123be39e25eaf46b73b6f151561b8b9d1bb7d7
MD5 15c4761f3e72ab2fd56d4621993a813d
BLAKE2b-256 5ee713c5119e06d6e18cdfbf1bd42020548dd1cd123f5dbe9f2958498a8a1ce9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page