Project Icon

git-absorb

智能Git工具实现自动bug修复和原子提交

git-absorb工具可自动识别并合并Git提交中的更改,简化代码审查流程。它支持生成fixup提交或直接修改历史,有助于维护原子提交。该工具适用于多个平台,安装简单,配置灵活,能有效提升Git工作效率。

git absorb

这是 Facebook 的 hg absorb 的移植版本,我最初是在 mozilla.dev.version-control 上读到的:

  • Facebook 演示了 hg absorb,这可能是我多年来看到的版本控制中最酷的工作流程改进。本质上,当你的工作目录在草稿变更集之上有未提交的更改时,你可以运行 hg absorb,未提交的修改会自动折叠("吸收")到适当的草稿祖先变更集中。这基本上相当于执行 hg histedit + "合并"操作,而无需进行提交或手动制定历史修改规则。该命令主要查看被修改的行,找到修改这些行的变更集,并修改该变更集以包含你未提交的更改。如果无法在不产生冲突的情况下进行更改,这些更改将保持未提交状态。这个工作流程对于应用审阅反馈等情况非常有用。你只需进行文件更改,运行 hg absorb,更改到提交的映射就会自动完成。这简直就是魔法。

简介

你有一个包含几个提交的功能分支。你的队友审阅了该分支并指出了一些bug。你已经修复了这些bug,但你不想把它们全都塞进一个不透明的提交中,写上"修复",因为你相信原子提交的理念。与其手动查找提交SHA来使用 git commit --fixup,或者运行手动交互式变基,不如这样做:

git add $FILES_YOU_FIXED
git absorb --and-rebase

git absorb 将自动识别哪些提交可以安全修改,以及哪些暂存的更改属于这些提交中的每一个。然后它会为每个更改写入 fixup! 提交。

使用 --and-rebase 标志,这些修复提交将自动整合到相应的提交中。或者,如果你不信任它,可以手动检查其输出,然后使用git内置的 autosquash 功能将修复折叠到你的功能分支中:

git add $FILES_YOU_FIXED
git absorb
git log # 检查自动生成的修复提交
git rebase -i --autosquash master

安装

安装 git absorb 最简单的方法是从最新的 标记版本 下载制品。制品可用于Windows、MacOS和Linux(在Ubuntu上构建,静态链接libgit2)。如果你需要尚未发布的提交,请查看 最新的CI制品 或提交问题。

另外,git absorb 在以下系统包管理器中可用:

打包状态
仓库命令
Arch Linuxpacman -S git-absorb
Debianapt install git-absorb
DPortspkg install git-absorb
Fedoradnf install git-absorb
FreeBSD Portspkg install git-absorb
Homebrew 和 Linuxbrewbrew install git-absorb
MacPortssudo port install git-absorb
nixpkgs stable 和 unstablenix-env -iA nixpkgs.git-absorb
openSUSEzypper install git-absorb
Ubuntuapt install git-absorb
Void Linuxxbps-install -S git-absorb
GNU Guixguix install git-absorb

从源代码编译

crates.io 徽章 构建

你需要以下内容:

然后运行 cargo install git-absorb。确保 $CARGO_HOME/bin 在你的 $PATH 中,这样git才能找到该命令。($CARGO_HOME 默认为 ~/.cargo。) 请注意,git absorb 并不使用系统的 libgit2。这意味着你不需要安装 libgit2 就能构建或运行它。但是,这也意味着你必须能够构建 libgit2。(由于 git2 crate 的最新变更,不再需要 CMake 来构建它。)

注意:cargo install 目前无法安装手册页(cargo#2729),所以如果你使用 cargo 进行安装,那么 git absorb --help 将无法工作。这里有一个手动解决方法,假设你的系统有一个 man --path 能识别的 ~/.local/share/man/man1 目录:

wget https://raw.githubusercontent.com/tummychow/git-absorb/master/Documentation/git-absorb.1
mv git-absorb.1 ~/.local/share/man/man1

使用方法

  1. 使用 git add 添加你想要吸收的任何更改。按设计,git absorb 只会考虑 git 索引(暂存区)中的内容。
  2. 运行 git absorb。这将在 HEAD 上创建一系列提交。每个提交都会有一个 fixup! 消息,指示它应该被合并到的提交的消息(如果唯一)或 SHA。
  3. 如果你对输出满意,运行 git rebase -i --autosquashfixup! 提交合并到它们的前驱提交中。你可以设置 GIT_SEQUENCE_EDITOR 环境变量,如果你不需要编辑 rebase TODO 文件。
  4. 如果你不满意(或发生了一些糟糕的事情),使用 git reset --soft 回到吸收前的提交以恢复你的旧状态。(你可以通过 git reflog 找到相关的提交。)如果你认为 git absorb 有问题,请提交一个问题。

工作原理(大致)

git absorb 的工作原理是检查两个补丁 P1 和 P2 是否可交换,也就是说,先应用 P1 再应用 P2 的结果是否与先应用 P2 再应用 P1 的结果相同。

git absorb 考虑一系列以 HEAD 结尾的提交。可以通过 --base <ref> 显式指定第一个提交。默认情况下,将考虑最后 10 个提交(参见下面的配置部分了解如何更改此设置)。

对于索引中的每个代码块,git absorb 将检查该代码块是否与最后一个提交可交换,然后是倒数第二个提交,以此类推。当它找到一个与代码块不可交换的提交时,它推断这是该更改的正确父提交,并将该代码块转换为一个修复提交。如果代码块与范围内的所有提交都可交换,这意味着我们没有为这个更改找到合适的父提交;此时会显示一个警告,这个代码块将保留在索引中未提交。

配置

堆栈大小

当不使用 --base 运行时,git-absorb 只会在特定范围内(默认为 10)搜索要修复的候选提交。如果你遇到这样的错误:

WARN stack limit reached, limit: 10

编辑你的本地或全局 .gitconfig 并添加以下部分

[absorb]
    maxStack=50 # 或者任何适合你项目的合理值

每个可修复提交只生成一个修复提交

默认情况下,git-absorb 会为每个可吸收的代码块生成单独的修复提交。你可以使用 -F 标志为所有可吸收到同一提交的代码块创建只一个修复提交。 要始终使用此行为,设置

[absorb]
    oneFixupPerCommit = true

如果没有暂存更改则自动暂存所有更改

默认情况下,git-absorb 只会考虑你通过 git add 暂存到索引的文件。但有时人们想尝试吸收所有更改,这需要先通过 git add . 暂存它们。为了避免这个额外的步骤,设置

[absorb]
    autoStageIfNothingStaged = true

这告诉 git-absorb,当没有暂存更改时,自动暂存所有更改,创建可能的修复提交,并从索引中取消暂存剩余的更改。

修复目标始终使用 SHA

默认情况下,git-absorb 将创建修复提交,其消息指向目标提交的摘要,如果有重复的摘要,将回退到指向目标的 SHA。可以通过以下设置始终指向目标的 SHA:

[absorb]
    fixupTargetAlwaysSHA = true

待办事项

  • 实现强制标志
  • 实现远程默认分支检查
  • 添加较小的强制标志以禁用单个安全检查
  • 停止使用 failure::err_msg 并确保所有错误输出对用户都是可操作的
  • 成功情况下稍微增加日志输出
  • 更多测试(特别是主模块和集成测试)
  • 记录堆栈和交换详情
  • 更多交换情况(特别是复制/重命名检测)
  • 不要同时将所有代码块加载到内存中,因为它们可能很大
  • 实现某种索引锁定以防止并发修改
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号