Skip to main content

Minimal Git extension for working with multi-commit stacks

Project description

Stacky

Stacky is a minimal Git extension providing a stack-like workflow with one PR per stack, rather than one PR per commit. This allows for easier integration with GitHub's current PR workflow.

Since GitHub doesn't natively support stacked PRs, workarounds fall into one of three categories: serial PRs (simple but slow), parallel PRs (fast but complex and requiring permissions), or single PRs with multiple commits (fast but less flexible to review). Stacky implements the latter, with a simple and intuitive interface.

Concept

The main idea is every stack is just a branch FEATURE with linear history rooted at its base branch FEATURE_base

(main)(FEATURE_base) > commit1 > commit2 > ... > commitN (FEATURE)

Successive commits move the stack's top branch, and rebases move the top-to-bottom stack of changes onto a new location.

One PR is created per stack, allowing reviewers to go through changes one commit at a time, while still testing and merging the stack as a single change.

Stacky is small and easy to understand, integrates natively with GitHub, and requires zero repo or org-level admin permissions or changes.

Install

brew install git-absorb  # optional
pip install git_stacky

Usage

Stacky provides four commands to manage stacks:

  • hack FEATURE create a new stack named FEATURE
  • rebase TARGET rebase the current stack onto TARGET
  • stacks list all stacks, optionally as a --graph
  • absorb absorb changes into the current stack

Here's an example workflow:

# Help text
(main)   git stack -h

# 1. New stack (apple, apple_base branches rooted at main)
(main)   git stack hack apple
(apple)  touch apple1 && git add -A && git commit -m 'apple1'
(apple)  touch apple2 && git add -A && git commit -m 'apple2'

# 2. New stack (banana, banana_base branches rooted at main)
(apple)  git stack hack banana
(banana) touch banana1 && git add -A && git commit -m 'banana1'

# 3. Rebase banana onto apple
(banana) git stack rebase apple

# 4. Rebase banana implicitly back onto main
(banana) git stack rebase

# 5. Force-delete banana stack
(banana) git checkout apple
(apple)  git stack stack -D banana

# History evolution
# 1. (main)(apple_base) > apple1 > apple2 (apple)
# 2. (main)(apple_base)(banana_base) > apple1 > apple2 (apple)
#                                    > banana1 (banana)
# 3. (main)(apple_base) > apple1 > apple2 (apple)(banana_base) > banana1 (banana)
# 4. (main)(apple_base)(banana_base) > apple1 > apple2 (apple)
#                                    > banana1 (banana)
# 5. (main)(apple_base) > apple1 > apple2 (apple)

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_stacky-0.2.0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

git_stacky-0.2.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file git_stacky-0.2.0.tar.gz.

File metadata

  • Download URL: git_stacky-0.2.0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.5 Darwin/23.6.0

File hashes

Hashes for git_stacky-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9b54bed013cf8a8e0dce6da60afc5b944c023e3dd63ce37928744d6d9789c558
MD5 f090c9cd8c1bc9ebfdd7d05aada3897d
BLAKE2b-256 b51e43dc96ae995502a5eadba6c0c89f4fcb430eee916c0253fafc5add358a08

See more details on using hashes here.

File details

Details for the file git_stacky-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: git_stacky-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.5 Darwin/23.6.0

File hashes

Hashes for git_stacky-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c9da2d70dfe4c48022f45091dfa82274cda247effd55c98ccbf68406b70b5f0
MD5 a4079de8935da3fd7626b365940f6395
BLAKE2b-256 0845310f3f346542b2c655a46e92db8f78babd6f6a8395aadaeaf2972ba285d2

See more details on using hashes here.

Supported by

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