git-stk

git-stk

Git-native stacked branch workflow helper with first-class GitHub and GitLab support.

Pitch

Stacking helps parallelize development and code review into smaller, easier-to-review changesets, and tools like git-stk exist to streamline the process of creating, updating, and otherwise managing those "stacks".

git-stk keeps stacks as ordinary Git branches, with stack parent metadata stored locally in .git/config as branch.<name>.stkParent.

Description

git-stk is a flexible and efficient tool designed to enhance the Git branching workflow by implementing a stacked branch strategy. It functions natively within Git, storing stack parent metadata locally in the .git/config file. Leverage this innovative helper for seamless integration with GitHub and GitLab review processes, improving collaboration and code management.

Key Features:

Stack Management: Easily create and manage stacked branches, allowing for a more organized development process.
Integration with Review Platforms: Automatically handle pull requests and merge requests on GitHub and GitLab, streamlining code reviews with formatted descriptions.

Quick Usage:

Start with a new stacked branch and submit them for review:

git stk new feature/api       # create a new stacked branch
# ...commit work...
git stk new feature/web       # create another stacked branch on top
# ...commit work...
git stk submit --stack        # submit all branches for review in order
git stk merge --all           # merge them from bottom to top in one command

Configuration:

git-stk allows for easy configuration through Git’s config system, ensuring that project-specific settings do not interfere with global Git configurations. Adjust settings like the review provider, push behavior, and draft submission options to tailor the experience to your workflow.

[stk]
    provider = github  ; Specify the review provider (github/gitlab/demo)
    pushOnSubmit = true; Push branches before submitting reviews
    submitDraft = true  ; Open new reviews as drafts

Install and Upgrade:

Installation is straightforward, with options to use scripts, Homebrew for macOS, or build from source using Cargo. Upgrade processes ensure that the latest version is integrated with minimal interruption to your workflow:

git stk upgrade              # Update to the latest release
git stk upgrade --force      # Force reinstall the latest release

Enhancements to Collaboration:

Dynamic Shell Completions: git-stk helps boost productivity with automatic command completions that adapt to your branch names and commands as you type.
Provider Detection: Automatically identifies the GitHub or GitLab servers, enhancing the user experience and integration capabilities.

For detailed information on all available commands, configuration options, and features, please refer to the comprehensive README in the repository. Utilize git-stk to simplify your Git workflow and improve project management and review processes.

0 comments

No comments yet.

New comment