如何优雅地合并开源项目更新到自己的魔改版本#
这就是我最近遇到的情况。我的博客项目 Cerry2022.github.io 基于一个很不错的 VitePress 博客模板 vitepress-blog-pure。我按照自己的想法修改了一些代码,加入了一些个性化的内容。但是,原始的 vitepress-blog-pure 仓库最近更新了一些很棒的功能和优化。作为一个“魔改者”,我当然希望能够享受到这些更新带来的好处,同时又不丢失我辛辛苦苦改动的代码。
下面我就以我的博客项目为例,分享一下如何使用 Git 来优雅地完成这个任务。
我的情况:
我的博客项目位于 D:\_Files\Project\Cerry2022.github.io,其中包含了从 vitepress-blog-pure 复制过来的基础代码,并且我已经对其进行了修改。现在,原始的 vitepress-blog-pure 仓库有了新的更新,我需要将这些更新合并到我的项目中。
操作步骤:
整个过程的核心思想是将原始仓库添加为我本地仓库的一个“远程仓库”,然后拉取它的更新,并合并到我自己的分支上。
cd D:\_Files\Project\Cerry2022.github.io尽管我们已经有了原始项目的代码,但为了方便获取更新,我们需要将原始的 vitepress-blog-pure 仓库作为我们本地仓库的一个新的远程仓库来关联。这相当于给原始仓库在我们本地仓库中起个别名。
首先,检查一下你当前已经关联的远程仓库:
git remote -v你会看到类似 origin 这样的远程仓库,它通常指向你自己的 GitHub 仓库 Cerry2022.github.io。
现在,添加原始的 vitepress-blog-pure 仓库 https://github.com/airene/vitepress-blog-pure.git:
git remote add upstream https://github.com/airene/vitepress-blog-pure.git再次运行 git remote -v 确认是否成功添加了 upstream。
现在,我们可以从 upstream 远程仓库拉取最新的代码和分支信息了:
git fetch upstream这个命令只会下载更新到你的本地,不会自动合并到你当前工作的分支。
现在到了关键一步,将从 upstream 拉取到的更新合并到你自己的分支上。我当前在 main 分支工作,并且原始仓库的主分支也是 main (请根据实际情况将 main 替换为你自己和原始仓库的主分支名称):
git merge upstream/mainGit 会尝试将 upstream/main 分支的更改合并到你当前所在的 main 分支。
常见错误(如果出现)
fatal: refusing to merge unrelated histories
这个错误表明 Git 认为你的本地仓库和 upstream/main 分支的历史是完全独立的,它们没有任何共享的提交。这通常发生在以下几种情况:
- 你直接下载了原始仓库的代码,然后在你自己的仓库中初始化了 Git,并将自己的仓库推送到一个空的远程仓库。在这种情况下,你自己的仓库历史和原始仓库历史是完全独立的。
- 你从原始仓库克隆 (git clone) 了代码,但在克隆之后,原始仓库的历史被重写了(例如,使用了 git rebase 或 git reset –hard 并强制推送)。
- 你将原始仓库的代码拷贝到了一个已有的、有自己历史的仓库中。
Git 默认阻止合并不相关的历史,是为了防止你意外地合并两个完全不同的项目,导致混乱的提交历史。但是,在你知道这两个项目实际上是相关的(一个基于另一个)并且你确实想合并它们的情况下,你需要显式地告诉 Git 允许合并不相关的历史。 解决方法是在 git merge 命令后面加上 –allow-unrelated-histories 选项。
git merge upstream/main --allow-unrelated-histories
解决冲突 (如果出现)
- 查看冲突文件: Git 已经标记了所有冲突的文件。你可以通过运行 git status 来再次查看冲突文件的列表。冲突文件会显示在 “Unmerged paths” 部分。
git status输出的一部分,Unmerged paths表示冲突文件,这部分是需要手动解决冲突的
Unmerged paths:
(use "git add <file>..." to mark resolution)
both added: .github/workflows/deploy.yml
both added: .gitignore
both added: .vitepress/config.ts
both added: .vitepress/theme/components/Archives.vue
both added: .vitepress/theme/components/Category.vue
both added: .vitepress/theme/components/Copyright.vue
both added: .vitepress/theme/components/NewLayout.vue
both added: .vitepress/theme/components/Page.vue
both added: .vitepress/theme/components/Tags.vue
both added: .vitepress/theme/custom.css
both added: .vitepress/theme/functions.ts
both added: .vitepress/theme/index.ts
both added: .vitepress/theme/serverUtils.ts
both added: changelog.md
both added: package.json
both added: pages/about.md
both added: pages/archives.md
both added: pages/category.md
both added: pages/tags.md
both added: pnpm-lock.yaml
both added: posts/vitepress-first.md
both added: public/favicon.ico- 手动解决冲突: 对于每个冲突文件,你需要手动编辑它们,并处理 Git 添加的冲突标记 («««< HEAD, =======, »»»> upstream/main)。
打开每个冲突文件(例如 .github/workflows/deploy.yml, .gitignore 等)在你的代码编辑器中,你会看到类似以下的结构:
<<<<<<< HEAD
// 这是我在本地的修改
console.log("My custom feature");
=======
// 这是原始仓库的修改
console.log("New feature from upstream");
>>>>>>> upstream/main你需要手动编辑这些文件:
- 找到冲突标记 (
<<<<<<< HEAD,=======,>>>>>>> upstream/main)。 - 仔细阅读
<<<<<<< HEAD到=======之间(你本地的修改)和=======到>>>>>>> upstream/main之间(原始仓库的修改)的代码。 - 根据你的需求,手动修改这部分代码,保留你想要的部分,并删除所有的冲突标记。
- 保存文件。
标记冲突已解决然后推送:#
git add <解决冲突的文件名>
git commit -m "Merge updates from upstream vitepress-blog-pure
git push origin main