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 namedFEATURE
rebase TARGET
rebase the current stack ontoTARGET
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file git_stacky-0.3.0.tar.gz
.
File metadata
- Download URL: git_stacky-0.3.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
Algorithm | Hash digest | |
---|---|---|
SHA256 |
78d66ba248efcfc11e79642a539578ea8b59f714157a3284f98e56e8f7fdc749
|
|
MD5 |
c215ae0413668821dc2fc4ac42b2d702
|
|
BLAKE2b-256 |
4df63dbe40425ab9694ae85c9017628f1617ef5496f5e30f18cb9a5e1b54f379
|
File details
Details for the file git_stacky-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: git_stacky-0.3.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
Algorithm | Hash digest | |
---|---|---|
SHA256 |
f8cea3c3989f08051c42d58dc89cb81e211fa479b7ff57f966b75895d2f55c3a
|
|
MD5 |
f8e6297b9745f68eefcd6b6e99dda2b1
|
|
BLAKE2b-256 |
dd9033e5c22652555b339c9622a0ca7f47bdfc3c54e7e8811034be16da495c26
|