git-absorb

git-absorb

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

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

git absorb版本控制代码修复自动提交工作流优化Github开源项目

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 在以下系统包管理器中可用:

<a href="https://repology.org/project/git-absorb/versions"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/825081e3-7c10-49ae-a287-af65c98d2a95.svg" alt="打包状态" align="right"> </a>
仓库命令
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 并确保所有错误输出对用户都是可操作的
  • 成功情况下稍微增加日志输出
  • 更多测试(特别是主模块和集成测试)
  • 记录堆栈和交换详情
  • 更多交换情况(特别是复制/重命名检测)
  • 不要同时将所有代码块加载到内存中,因为它们可能很大
  • 实现某种索引锁定以防止并发修改

编辑推荐精选

TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多