提交时用错邮箱,比一个 bug 更伤客户信任
从按目录区分身份到遵守评审规则,五个习惯让你在客户内部 GitLab 上的第一个合并请求不再卡住。
要点速览
- 一个目录对应一个身份:有了 includeIf gitdir,就不会再用错邮箱向客户仓库提交。
- 用客户名称命名远程仓库,分开拉取和推送的来源,别让所有远程都叫 origin。
- 在客户机器上不要用 store 助手,它会把密码写进一个永不过期的明文文件;写第一行代码之前先读 CODEOWNERS。
第一周的周三下午,合并请求卡住了:Merge 按钮是锁定状态,提交历史里,你的个人邮箱和客户公司的邮箱排在一起。
设想你在一家银行的第一周。你拿到一台禁止自行安装软件的笔记本、一个银行内部 GitLab 账号,以及一个有十几个分支的仓库,分支以各地分行命名。这个场景里没有任何技术难点。但这类失误比 bug 更快消耗客户的信任,因为它说明你还没有弄懂客户的环境。
对前线部署工程师(FDE)来说,客户现场的 Git 是一项操作技能,包含五件事:在不属于自己的机器上安装 Git,管好自己的身份,管理多个远程仓库,保护好凭据,以及遵守客户的评审规则。
客户的机器,客户的规矩
第一件事是让 Git 跑起来。Pro Git 指出,在 Ubuntu 等基于 Debian 的 Linux 发行版上用 apt 安装。在 macOS Mavericks(10.9)及以上版本,第一次在终端输入 git 时,系统会提示安装 Xcode Command Line Tools。
Windows 上最容易卡住。官方构建来自 Git for Windows,这是一个独立于 Git 本身的项目;Chocolatey 包则由社区维护。在客户锁定的虚拟机上,下载任何东西之前先问 IT 允许哪些来源,因为从错误的来源下载,可能会变成一张安全工单。
如果客户的操作系统自带的 Git 版本很旧,Pro Git 提到可以从源码安装最新版。这只能作为最后手段,而且前提是客户允许在其机器上编译。
一个目录,一个身份
同时服务多个客户的人,最常见的错误是用全局 user.email 提交。git config 文档描述的正是这种情况:可以通过带 gitdir 条件的 includeIf,按工作树所在的目录使用不同的 user.name 和 user.email。
最简单的结构是每个客户一个目录。在 ~/.gitconfig 中:
[user]
name = Nguyen Van A
email = [email protected]
[includeIf "gitdir:~/clients/bank/"]
path = ~/clients/bank/.gitconfig
在 ~/clients/bank/.gitconfig 中:
[user]
email = [email protected]
现在,~/clients/bank/ 下的所有仓库都会使用客户分配的邮箱。验证方法:cd 进其中一个仓库,运行 git config user.email。git config 文档正是用这类条件把配置应用到某个目录下的所有仓库,所以每个客户只需声明一次。
origin 到底是谁的?
从客户的 GitLab 克隆时,默认远程仓库叫 origin。几周后,你又添加了自己公司的一个内部仓库,用来存放共享的集成代码,origin 就开始含糊不清了。从一开始就改名:
git remote rename origin bank
git remote add internal [email protected]:fde/connector.git
git fetch internal
git branch -r
根据 git remote 文档,rename 还会同步更新所有远程跟踪分支和相关配置,不需要手动修改。执行 git fetch internal 之后,分支显示为 internal/feature-x,与 bank/feature-x 区分开来。
Git 文档还有一条值得记住的建议:如果从一个地方拉取、向另一个地方推送,就使用两个独立的远程仓库。在客户现场,这条规则能避免最糟糕的结果:把客户的代码推到自己公司的服务器,或者反过来。每次推送前都明确写出远程名称(git push bank feature/x),不要让 Git 去猜。
在一个为各地分行或子客户建了大量分支的仓库里,清晰的远程名称让 git branch -r 的输出像一张地图,仅看前缀就知道哪个分支属于谁。
在别人的机器上,密码存在哪里?
Git 默认不保存凭据,所以每次通过 HTTPS 推送都要重新输入。人们的本能反应是启用 store 助手,而在客户的机器上,这是个错误。Pro Git 说得很明确:store 模式把凭据保存在磁盘上的明文文件里,并且永不过期。
在客户所有的笔记本或虚拟机上,尤其是共享的机器上,这样一个文件就是一个署着你名字的安全漏洞。更合理的选择是 cache 助手,它把凭据保存在内存中,15 分钟后清除:
git config --global credential.helper cache
每次长时间离开后都要重新输入,确实有点麻烦,但比起一次安全调查,代价小得多。如果客户有自己的令牌策略,按客户的策略执行。
写代码之前,先读评审规则
回到那个被锁定的合并请求。在 GitLab 上,客户可以开启必需审批:根据 GitLab 文档,合并请求在获得指定人员的足够审批之前无法合并。这是客户的流程,不是故障。
问题在于谁需要审批。GitLab 通过 CODEOWNERS 文件按文件确定评审人。如果一个合并请求同时改动了支付目录和报表目录,你很可能需要两个不同的小组签字,而你的合并请求(MR)要等最慢的那个小组。
所以,创建分支之前,先打开 CODEOWNERS,找到与你计划改动路径匹配的行。拆分改动,让每个 MR 只需要一个负责人小组审批,并提前给这个小组发一条简短消息,说明即将提交的内容。一个改动小、发给对的人、事先打过招呼的 MR,通常比一个同时落进三个团队收件箱的大 MR 推进得更快。
反复出现的错误
最常见的是用个人邮箱向客户仓库提交,解决办法是在写第一行代码之前配置好 includeIf。其次是所有远程都叫 origin,结果推错了服务器。然后是为了不输密码,在共享机器上启用 store。
最后一个更难察觉:把客户的评审流程当成障碍,想办法绕过去。审批和 CODEOWNERS 告诉你谁才是这段代码真正的负责人,也就是说,他们正是你需要尽早认识的人。
如果你在为 FDE 岗位准备简历,把“熟练掌握 Git”换成具体的描述:“在客户内部 GitLab 上工作,遵循必需审批和 CODEOWNERS 流程,管理多个远程仓库和按客户区分的身份”。再准备一个简短的例子,用于面试时讲述你如何按负责人小组拆分 MR。
在客户现场,仓库不属于你,但每一次提交都带着你的签名。从第一天起就配置正确,是让这个签名始终可信的最低成本方式。
这篇文章对你有帮助吗?
感谢你的反馈!