logo

terminal cast

GraphQL用户

查看我的公司Inigo，了解最全面的API平台。

GitHub上的堆叠式拉取请求

轻松管理GitHub上的堆叠式拉取请求。 git spr是一个客户端工具，通过使用GitHub的拉取请求和分支，实现了简单流畅的堆叠式差异工作流程。git spr为您管理拉取请求堆栈，让您无需操心。

使用git spr，每个提交都会成为一个拉取请求，每个分支都成为一堆拉取请求的堆栈。这允许在单个分支上堆叠多个提交，避免了为每个新的更改或功能启动新分支的开销。小的更改和拉取请求变得简单快速。您不必担心堆叠在一起的分支以及管理复杂的拉取请求堆栈。最终结果是更加流畅、更快速的软件开发周期。

安装

Brew

brew tap ejoffe/homebrew-tap
brew install ejoffe/tap/spr

Apt

echo "deb [trusted=yes] https://apt.fury.io/inigolabs/ /" | sudo tee /etc/apt/sources.list.d/inigolabs.list
sudo apt update 
sudo apt install spr

手动安装

从发布页面下载预编译的二进制文件，并复制到您的bin路径。

从源码安装

安装goreleaser并运行make。二进制文件可以在dist目录中找到。

make bin

工作流程

像往常一样将您的更改提交到分支。请注意，每个提交最终都会成为一个拉取请求。

> touch feature_1
> git add feature_1
> git commit -m "Feature 1"
> touch feature_2
> git add feature_2
> git commit -m "Feature 2"
> touch feature_3
> git add feature_3
> git commit -m "Feature 3"

提交消息的主题将成为拉取请求的标题，消息的正文将成为拉取请求的正文。如果您有一个正在进行的更改需要提交，但还不想创建拉取请求，请以全大写的WIP开始提交消息。spr脚本不会为任何以WIP开头的提交创建拉取请求，当您准备好创建拉取请求时，请删除WIP。您无需为每个更改创建新分支，也不必调用git push将代码推送到GitHub。相反，只需调用git spr update即可。

管理拉取请求

运行git spr update将您的整个提交堆栈同步到GitHub，并为堆栈中的每个新提交创建拉取请求。如果提交被修改，拉取请求将自动更新。该命令输出您的开放拉取请求列表及其状态。git spr update将您的提交推送到GitHub并为您创建拉取请求，因此您无需手动调用git push或在UI中手动打开拉取请求。

> git spr update
[⌛❌✅❌] 60: Feature 3
[✅✅✅✅] 59: Feature 2
[✅✅✅✅] 58: Feature 1

要仅更新部分堆栈，请使用--count标志指定要更新的堆栈中的拉取请求数量。拉取请求将从堆栈底部向上更新。

修改提交

当您需要更新提交时，无论是修复测试、根据审查意见更新代码，还是仅仅因为想要更改，您都应该修改提交。使用git amend可以轻松修改堆栈中任何位置的更改。暂存您想要修改的文件，然后不要调用git commit，而是使用git amend并在提示时选择您想要修改的提交。

> touch feature_2
> git add feature_2
> git amend
 3 : 5cba235d : Feature 3
 2 : 4dc2c5b2 : Feature 2
 1 : 9d1b8193 : Feature 1
Commit to amend [1-3]: 2

合并状态位

每个拉取请求都有四个合并状态位，表示请求是否可以合并。要合并请求，所有必需的状态位都需要显示**✔**。每个状态位的含义如下：

GitHub检查运行并通过

⌛ : 待处理
❌ : 某些检查失败
✅ : 所有检查通过
➖ : 合并不要求检查（可在yml配置中配置）

拉取请求批准

❌ : 拉取请求尚未被批准
✅ : 拉取请求已被批准
➖ : 合并不要求批准（可在yml配置中配置）

合并冲突

❌ : 提交有需要解决的冲突
✅ : 提交没有冲突

堆栈状态

❌ : 提交下面有其他无法合并的拉取请求
✅ : 此提交以下的所有提交都可以合并

拉取请求批准和检查要求可以在配置文件中禁用，详情请参阅下面的配置部分。

显示当前拉取请求

使用git spr status查看您的拉取请求堆栈状态。在以下情况下，三个拉取请求都是绿色的，可以合并，一个拉取请求正在等待审查批准。

> git spr status
[✅❌✅✅] 61: Feature 4
[✅✅✅✅] 60: Feature 3
[✅✅✅✅] 59: Feature 2
[✅✅✅✅] 58: Feature 1

合并拉取请求

您的拉取请求是堆叠的。不要使用GitHub UI来合并拉取请求，如果您按错误的顺序合并，可能会将一个拉取请求推入另一个，这可能不是您想要的。相反，只需使用git spr merge，您就可以一次性合并所有可合并的拉取请求。合并后的请求状态将在剩余的拉取请求之后打印。为了一次性合并所有拉取请求而不触发额外的GitHub检查，spr会找到最顶层的可合并拉取请求。然后它将所有提交合并到这个拉取请求中，合并这个请求，并关闭其余的拉取请求。这一开始可能会有些意外，并且有一些副作用，但到目前为止还没有找到更好的解决方案。

> git spr merge
已合并 #58 功能1
已合并 #59 功能2
已合并 #60 功能3
[✅❌✅✅] 61: 功能4

要只合并部分堆栈，请使用 --count 标志加上您想要合并的堆栈中的拉取请求数量。拉取请求将从堆栈底部向上合并。

> git spr merge --count 2
已合并 #58 功能1
已合并 #59 功能2
[✅❌✅✅] 61: 功能4
[✅✅✅✅] 60: 功能3

默认情况下，合并使用变基合并方法，可以通过mergeMethod配置进行更改。

开始新的堆栈

开始新的堆栈是通过创建新分支实现的。例如，如果您想从当前分支的最新推送状态开始一个新的堆栈，使用 git checkout -b new_branch @{push}。

配置

首次运行脚本时会创建两个配置文件。仓库配置保存在仓库基础目录的 .spr.yml 文件中。用户特定配置保存在用户主目录的 .spr.yml 文件中。

仓库配置	类型	默认值	描述
requireChecks	布尔	true	要求检查通过才能合并
requireApproval	布尔	true	要求拉取请求获得批准才能合并
githubRepoOwner	字符串		GitHub所有者名称（从git远程配置获取）
githubRepoName	字符串		GitHub仓库名称（从git远程配置获取）
githubRemote	字符串	origin	要使用的GitHub远程名称
githubBranch	字符串	main	拉取请求目标的GitHub分支
githubHost	字符串	github.com	GitHub主机，可以更新以用于GitHub企业版用例
mergeMethod	字符串	rebase	合并方法，有效值：[rebase, squash, merge]
mergeQueue	布尔	false	使用GitHub合并队列合并拉取请求
prTemplatePath	字符串		PR模板路径（例如 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md）
prTemplateInsertStart	字符串		在PR模板中搜索以确定正文插入起始位置的文本
prTemplateInsertEnd	字符串		在PR模板中搜索以确定正文插入结束位置的文本
mergeCheck	字符串		使用 'git spr check' 强制执行合并前检查
forceFetchTags	布尔	false	运行 'git spr update' 时也获取标签
branchNameIncludeTarget	布尔	false	在拉取请求分支名称中包含目标分支名称
showPrTitlesInStack	布尔	false	在拉取请求正文的堆栈描述中显示PR标题
branchPushIndividually	布尔	false	单独推送分支而不是原子式推送（仅在需要避免超时时启用）

用户配置	类型	默认值	描述
showPRLink	布尔	true	显示完整的拉取请求http链接
logGitCommands	布尔	true	将所有git命令记录到标准输出
logGitHubCalls	布尔	true	将所有GitHub API调用记录到标准输出
statusBitsHeader	布尔	true	显示状态位类型标头
statusBitsEmojis	布尔	true	使用花哨的表情符号显示状态位
createDraftPRs	布尔	false	新建的拉取请求创建为草稿状态
preserveTitleAndBody	布尔	false	更新拉取请求时不会覆盖PR标题和正文
noRebase	布尔	false	为true时，spr update不会在原始分支之上变基