VS Code本地合并Git分支已stash仍报错需提交/暂存更改咨询

报错信息 #

执行分支合并时触发如下报错，操作被终止：

error: Your local changes to the following files would be overwritten by merge:
        Main.txt
    Please commit your changes or stash them before you merge.
    Aborting

问题背景 #

• 本地仓库共拉取两个分支：
  • Main分支：包含Main.txt文件
  • Second分支：包含Main.txt文件
• 当前在VS Code中检出的是Second分支，本地修改过该分支下的Main.txt，修改内容和本地Main分支的Main.txt版本存在冲突，已经对该文件的修改执行过stash暂存操作。

复现场景 #

尝试将Main分支合并到当前所在的Second分支，操作界面如下：

操作后触发上述报错，完整执行日志如下：

[2022-06-07T13:56:57.959Z] > git merge main [126ms]
[2022-06-07T13:56:57.959Z] error: Your local changes to the following files would be overwritten by merge:
    Main.txt
Please commit your changes or stash them before you merge.
Aborting
[2022-06-07T13:59:31.068Z] > git ls-files --stage -- C:\Users\userName\repos\myApp2\myApp\Home.txt [210ms]
[2022-06-07T13:59:31.080Z] > git ls-files --stage -- C:\Users\userName\repos\myApp2\myApp\Home.txt [232ms]
[2022-06-07T13:59:31.164Z] > git symbolic-ref --short HEAD [152ms]
[2022-06-07T13:59:31.229Z] > git cat-file -s xxx [150ms]
[2022-06-07T13:59:31.244Z] > git cat-file -s xxx [155ms]
[2022-06-07T13:59:31.334Z] > git for-each-ref --format=%(refname)%00%(upstream:short)%00%(objectname)%00%(upstream:track) refs/heads/Second refs/remotes/Second [160ms]
[2022-06-07T13:59:31.511Z] > git remote --verbose [160ms]
[2022-06-07T13:59:31.526Z] > git for-each-ref --sort -committerdate --format %(refname) %(objectname) %(*objectname) [183ms]
[2022-06-07T13:59:31.663Z] > git config --get commit.template [125ms]

已确认界面显示更改暂存操作完成

解决方法 #

报错核心原因是执行merge时工作区仍存在未提交的文件改动，Git为避免本地修改被覆盖直接终止操作，即使做过stash也可能存在暂存不全、操作未生效的情况，按以下步骤处理即可：

1. 先执行命令确认当前工作区状态，检查是否存在未被暂存的残留改动：

   git status
   

   如果输出中Main.txt仍显示为modified状态，说明之前的stash操作没有成功收纳该文件的改动。
2. 重新将所有未提交改动强制暂存：

   git stash push -m "暂存Second分支本地修改"
   

3. 再次执行git status确认工作区无未提交改动后，执行合并操作：

   # 当前处于Second分支，合并Main分支内容
   git merge main
   

4. 合并完成、处理完所有冲突后，恢复之前暂存的本地改动：

   git stash pop
   

如果确认本地未提交的改动完全不需要，可以直接执行git reset --hard HEAD清空工作区所有未提交改动后再合并，注意该操作会永久删除未提交的本地修改，执行前务必确认内容无用。

VS Code UI界面合并冲突操作说明 #

VS Code原生支持图形化处理合并冲突，不需要完全依赖命令行，操作流程如下：

• 确认本地改动全部提交或暂存、工作区干净后，点击VS Code底部状态栏显示的当前分支名称，在弹出的分支列表中选中要合并的目标分支，选择「将分支合并到当前分支」选项
• 若两个分支存在内容冲突，VS Code会自动标记所有冲突文件，打开对应文件后，每个冲突块都会提供三个快捷操作选项：
  • 保留当前分支的更改
  • 保留传入分支的更改
  • 同时保留双方更改
• 逐一对所有冲突块确认保留内容，处理完全部冲突文件后，在源代码管理面板输入提交信息，即可完成合并提交。

内容的提问来源于stack exchange，提问作者Pingpong