修改历史

2016-07-29 修改部分内容

如果项目很大,分为众多模块,并且需要对每个模块单独进行版本控制的时候,引入git submodule是一个非常不错的选择。尤其是对一些sdk+plugin的项目尤为适用。

比如本站是使用hexo搭建的博客,其中使用的主题与插件,都是在迁移博客时同步开发的,但是这主题与插件,同样可以应用到其它的博客站点,所以,不能把源文件、主题和插件纳入同一个代码仓库进行版本控制,为方便主题与插件的版本控制,它们在github上都建立了单独的代码仓库。对于博客源文件、主题及插件的修改,只能提交到其对应的git仓库。

为方便理解,将我的博客工程结构列举如下:

hexo-site #整个工程,对应 hexo-site 仓库
    source #博客源文件
    themes # 主题目录,在hexo-site仓库.gitignore中
        nova  # 主题,对应hexo-theme-nova仓库
    node_modules # 插件目录,在hexo-site仓库.gitignore中
        hexo-generator-github #插件1,对应hexo-generator-github仓库
        hexo-generator-i18n #插件2,对应hexo-generator-i18n仓库

其中hexo-site对应Jamling/hexo-site.git,themes/nova目录对应Jamling/hexo-theme-nova.git,node_modules/下的github和i18n插件对应的也是单独的git仓库。

为了保持博客源文件的干净,在.gitignore文件中,把themes目录和node_modules目录都加入了。所以,主题与插件的修改,都不会影响到hexo-site仓库。

在hexo-site目录下,通过git submodule add命令添加主题及插件子模块

Copy Code

git submodule add -f git@github.com:Jamlng/hexo-theme-nova themes/nova
git submodule add -f git@github.com:Jamlng/hexo-generator-github node_modules/hexo-generator-github
git submodule add -f git@github.com:Jamlng/hexo-generator-i18n node_modules/hexo-generator-i18n

加-f选项,是因为themes目录和node_modules目录加入了.gitignore,git submodule add第一个参数为子模块的git仓库地址,第二个参数为子模块的名字。子模块成功添加之后,会在hexo-site目录下创建一个.gitmodules文件。内容如下:

Copy Code

[submodule "themes/nova"]
    path = themes/nova
    url = gh:Jamling/hexo-theme-nova
[submodule "node_modules/hexo-generator-github"]
    path = node_modules/hexo-generator-github
    url = gh:Jamling/hexo-generator-github
[submodule "node_modules/hexo-generator-i18n"]
    path = node_modules/hexo-generator-i18n
    url = gh:Jamling/hexo-generator-i18n

如果对git submodule命令不熟,可以使用git submodule add --help查看帮助,也可以通过直接修改.gitmodules文件来添加。

注:将子模块加入.gitignore的好处是主仓库中不会出现子模块需要更新的提示,进一步将主仓库与子模块独立开来,但是缺点就是,如果要更新子模块,须单独cd到子模块目录,手动git pull更新。

子模块添加成功之后,主仓库与子模块的操作都是独立的。执行git status等操作,只会看到当前仓库的变更,跟其它的仓库(模块)没有任何关系。