This changed a lot since I'm using Graphite, It'll update the branches automatically, with a single command.

You can learn more in the Getting Started docs.

Summary

Setup

$ gt user branch-prefix --set kevin/
$ gt user editor --set vim
$ gt auth --token <PASTE>

# Optional (use original commit date/author on internal rebase/restack)
$ gt user restack-date --use-author-date

Workflow

$ gt bco main
 # do work
$ git add .
$ gt bc wip/foo-bar-baz
 # do more work
$ git add .
$ gt cc -m "something"
 # branch is probably ready to submit but I have related work to do
$ gt b rename kevin/foo-bar-baz
 # do related work
$ git add .
$ gt bc wip/new-stack
 # more work
$ git add .
$ gt ca
$ gt b rename kevin/new-stack
 # ready to submit the whole stack
$ gt ss

It’s not uncommon for me to have multiple unrelated wip branches. For example my current seaplane repo looks like this:

$ gt l
◯ kevin.asyncify PR #118 (Draft)
│ [DO NOT MERGE] Convert to async
│ 4 days ago
│ * a4fc67 - update doc examples to async
│ * 47dd62 - update api tests to async
│ * 12cb09 - makes the SDK async
│
│  ◯ wip.formation-configuration-command
│  │ 4 days ago
│  │ * 419062 - stub formation configuration commands
│  │
│  │  ◉ wip.init-ui-tests (current)
│  │  │ 4 days ago
│  │  │ * 40cb81 - init-ui-test: adds base init tests
│  │  │
│──┴──┘
│
◯ main
│ 4 days ago
│

Useful/Most Used Commands

Branch Related
- gt bco foo (branch checkout): Check out existing branch foo
- gt b top (branch): Go to the top of the stack (or gt b up to go up one level)
- gt b bottom: Go to the bottom of the stack (gt b down to go down one level)
- gt b rename : Rename current branch
- gt bco foo && gt sr: Check out foo which is behind main and catch it up on top of main
Stack Related
- gt sr (stack re-stack): Regenerate graphite metadata based on current git structure (i.e. you did some git commands to mess with branches an now want Graphite to re-track it all)
- gt ss (stack submit): Submit or update the stack
- gt ss -u (update-only): Submit the stack, but only update existing PRs
Commit Related
- gt cc -m "foo" (commit create): Create a commit with message “foo”
- gt ca (commit amend): Amend last commit
Repo Related
- gt l (log): Display the branch stack graph
- gt rs (repo sync): Repo sync; pull down latest changes and branches, rebasing as required

More specialized command are the gt ds and gt us (downstack/towards main and upstack/away from main) which I primarily use with sync so... gt dss [-u] or gt uss [-u].

Merging a Stack!

[(Graphite has added some docs on merging stacks from their web UI now)](https://docs.graphite.dev/guides/graphite-dashboard/merging-your-pull-requests#merging-a-stack-of-prs)

So your PR was approved 🎉 Now you’re ready to merge. But wait!

The best method to merge stacked PRs is either bottom to top (closest to main to furthest way from main). One could also use a top to bottom (furthest away from main down to main) approach, but you lose some benefits in stacked PRs (i.e. the end result in main is a single squashed PR from all stacks).

⚠️ Do not merge a stacked PR without the base branch (the PR immediately below it, or closer to main) having been approved first! ⚠️

Example Merge

Imagine a stack of Three PRs which Graphite displays at the command line roughly this:

$ gt l
◉ kevin.branch-3 (current) PR #3
│ 4 days ago
│ * a4fcef - even more work
│
◯ kevin.branch-2 PR #2
│ 4 days ago
│ * b2fc11 - some more work
│  
◯ kevin.branch-1 PR #1
│ 4 days ago
│ * c5fc67 - some work
│
◯ main
│ 4 days ago

Or in the PR comment displayed like:

◉ main
    ◯ PR branch-1 #1 Graphite (this PR)
        ◯ PR branch-2 #2 Graphite 
            ◯ PR branch-3 #3 Graphite

Wait for PR 1 to be approved and merge into main (do this ✅)
Then wait for PR 2 to be approved and merge into main
Then wait for PR 3 to be approved and merge into main

Example Merge with Rebase

Sometimes after you merge a base branch, the branch/PR above it contains merge conflicts as reported by Github. In these situations my workflow generally looks like this:

I’ve merged the base branch; now Github is saying the PR next up in the stack has merge conflicts

$ gt rs
  # Pull down the latest, including the recent merge
  # pick 'y' to delete old merged branches
$ gt l
  # Make sure Graphite automatically rebased in-flight PRs to stay
  # above 'main'
  # You can see this by if your open PRs are above or below 'main'

  # if they have fallen below 'main' and Graphite didn't automatically
  # fix them up
$ gt bco my-next-pr-branch
  # check out the PR branch that is next up
$ gt sr
  # rebase onto main
  # do any normal rebase fixing required, potentially with rounds
  # of 'gt continue' (git rebase --continue)
$ gt ss [-u]
  # Ensure the in-flight PRs are updated appropriately
  # 
  # Add -u if you have branches in the stack that do not have active PRs

tonilopezmr / tonilopezmr.github.io

Merge sequential branches using rebase #11