gitfu

package module
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 8, 2017 License: MIT Imports: 0 Imported by: 0

README

git-pr attempts to make managing multiple interdependent GitHub pull requests easier.

Installation

Binaries

Pre-built 64-bit binaries are available for Linux and Mac at https://github.com/abhinav/git-pr/releases. To install, simply unpack the archive and put the binaries somewhere on your $PATH.

For example, if you have $HOME/bin on your $PATH,

OS=$(uname -s | tr '[:upper:]' '[:lower:]')
VERSION=v0.6.0
URL="https://github.com/abhinav/git-pr/releases/download/$VERSION/git-pr.$VERSION.$OS.amd64.tar.gz"
curl -L "$URL" | tar xv -C ~/bin

Build From Source

If you have Go installed and set up, use the following command to build git-pr from source.

go get github.com/abhinav/git-pr/cmd/git-pr

Commands

The following subcommands are provided:

land

git pr land
git pr land mybranch

This does a few things:

  • Squash-merges a specific pull request, defaulting to the pull request made with the current branch
  • Allows editing the commit message for the squash commit, defaulting to the PR title and body for the commit message
  • Pulls the merge base
  • Performs post-merge cleanup like deleting local and remote branches
  • Rebases PRs that depend on the merged pull request; see the rebase command for more information

Given the layout,

     o---o feature2
    /
o--o master
    \
     o---o feature1
          \
           o---o feature3

Running,

$ git checkout feature2
$ git pr land

The resulting layout will look like so,

o--o--o master'
       \
        o---o feature1
             \
              o---o feature3

  master' = master + feature2

Afterwards, running the following,

$ git checkout feature1
$ git pr land

Will result in,

o--o--o--o master''
          \
           o---o feature3

  master'' = master' + feature1

rebase

git pr rebase --onto master
git pr rebase --onto master mybranch

Rebases the pull request for this branch onto the given base branch, also rebasing any dependent branches for that PR onto the new head of this PR.

Given the layout,

o---o---o master
     \
      o feature1
       \
        o--o--o feature2
         \
          o--o feature3

Running,

$ git checkout feature1
$ git pr rebase --onto master

Will result in,

o---o---o master
         \
          o feature1
           \
            o--o--o feature2
             \
              o--o feature3

The --onto argument may be skipped to leave the current branch unchanged but rebase all its dependent PRs onto its updated head. So the above could also be achieved with,

$ git checkout master
$ git pr rebase

Stability

Pre-alpha. Extremely unstable. Barely tested.

Documentation

Overview

Package gitfu is the root package for the git-pr library.

Directories

Path Synopsis
cli
cmd
git
pr

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL