Skip to main content

Manage GitHub Pull Request stacks.

Project description

jeeves-pr-stack

jeeves-pr-stack is a plugin for jeeves that helps manage stacks of GitHub pull requests. It aims to simplify the code review process by organizing pull requests that depend on each other.

Installation

poetry add --group dev jeeves-pr-stack

Motivation

While pull requests are a powerful tool for code review, they tend to become larger and larger, and thus more difficult for the reviewer to tackle.

One possible way to resolve that is to split implementation of a feature into two or more pull requests. For instance,

  • PR #42 Backend for the Super Feature directed from super-feature-backend branch to main branch,
  • and PR #43 Frontend for the Super Feature directed from super-feature-frontend branch to super-feature-backend branch.

The PRs are written in such a way that the first of them can be independently merged to main and deployed without breaking the system. This makes the process of code review faster and easier, and allows to deploy more often.

Let's call such structures PR Stacks.

Caveats

Managing PR Stacks manually can be tedious; for instance, every time when changing #42 you need to rebase #43. It becomes particularly annoying when the length of the stack is more than 2.

jeeves-pr-stack comes to the rescue.

Commands

j stack

View the current PR Stack.

j stack push

  • Create a new PR in current branch if none exists, or use the one that is there,
  • And set the base branch of this PR to point to another open PR in the repository, stacking one PR on top of another.

j stack pop

  • Fetch the bottom-most PR of current stack,
  • Merge it into the repository main branch,
  • Redirect the follow-up PR to point to the main branch so as to make it mergeable,
  • And delete the branch of the PR that was merged.

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

jeeves_pr_stack-0.1.6.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

jeeves_pr_stack-0.1.6-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file jeeves_pr_stack-0.1.6.tar.gz.

File metadata

  • Download URL: jeeves_pr_stack-0.1.6.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/6.8.0-54-generic

File hashes

Hashes for jeeves_pr_stack-0.1.6.tar.gz
Algorithm Hash digest
SHA256 a96df97ec86f9ff13f848ba4e47d4d3c691efc59f5a5a7832c37cbe4192991bc
MD5 cedfd43c2c7bfe990faf7f3b1fa0bd99
BLAKE2b-256 b2792d1f793ebec6107f1024d7dd359d5d3da1b6bb82f5744f81c1adba426a8b

See more details on using hashes here.

File details

Details for the file jeeves_pr_stack-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: jeeves_pr_stack-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/6.8.0-54-generic

File hashes

Hashes for jeeves_pr_stack-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 401221919e18b6a2168a96a3bc3e70518c5c44eb428239b62b6c20359bf47160
MD5 af29cbee36b887f087568f89c5fd25cf
BLAKE2b-256 64f512ced92a43f55e51622697354ac4b860108e560d0037abc0176ed2936ae1

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