Git系列:运用Git创建空白分支进行项目相关文档管理

文章目录

  • 起因
  • 一、为什么会选择Git分支
  • 二、Git分支的简单介绍和好处
  • 三、本次的具体操作
    • 1.$git checkout --orphan XXX
    • 2.删除当前分支里的内容
    • 3.提交新的分支
  • 总结


起因

项目管理过程中没有做好相关文档管理,比如需求,开发,测试等文档,需要对项目在过程中产生的相应文档进行管理,目前使用的是Git进行代码库管理,因此考虑通过Git进行相应的文档库管理。下面就是这次的一个考虑过程,供大家参考。

一、为什么会选择Git分支

起初,考虑将代码和项目文档统一放在master下,这样会带来一个弊端,大部分情况下,Git仓库下载都是全库下载,如果对只需要查看文档的小伙伴来说,这种方式就会把代码库同时下载下来,如果需要单文件下载,需要运行命令,这对不是开发的同事来说,可能不是很友好,因此这个方案被过掉了,转而采取了分支的方式去进行文档管理。

二、Git分支的简单介绍和好处

对开发小伙伴来说,分支的概念并不陌生,简单介绍一下,就是在版本控制过程中,同时推进多个任务,开发人员可以为每个任务创建单独的分支。使用分支意味着开发人员可以把自己的当前任务从开发主线上分离开,开发自己分支的时候,不会影响主线分支的运行。

好处就是:
1、同时并行推进多个功能开发,提高开发效率
2、各个分支在开发过程中,如果一个分支开发失败,不会对其他分支有任何影响。失败的分支删除重新开始即可。

有关分支的操作命令,这里就不多说了,可以自行查找。

三、本次的具体操作

如果项目在开发过程中,创建分支,不管是在网页端,还是通过其他客户端进行创建,基本上都是会让选择基于某一个分支作为初始节点,因此采用命令的方式就显得很重要。

1.$git checkout --orphan XXX

切换到本地的仓库目录,打开git bash,输入命令:git checkout --orphan XXX,然后后会提示:Switched to a new branch XXX,这时候就已经切换到新创建的分支下了。
在这里插入图片描述

2.删除当前分支里的内容

git rm -rf .

3.提交新的分支

以上两个步骤,只是在本地创建了一个新的空白分支,还需要把分支上传到代码库,空白分支是无法提交的,因此需要创建新的文件

$echo 'README' >> README.md
$git add README.md
$git commit -m 'xxx'
git push origin new_branch

这样一个新的空白分支就上传到代码库了,后面就可以上传相关文档到分支里了。

其他需要查看文档的人员,只需要在Git的网页端去下载分支文件夹就可以了。
Git系列:运用Git创建空白分支进行项目相关文档管理_第1张图片

注:操作过程中注意分支的切换,Git的分支在切换的时候,是在本地的同一个目录下去切换的,因此,在两个不同文件的分支进行切换的时候,会发现本地的文件有所不同。

总结

以上,就是本次的操作的一个全过程,其实,貌似这个分支的方案也不是很好用。。。。所以,最后我还是没用这个方案,采用了云文档的方式。。。不知道大家是如何去管理项目中的文档的,欢迎在评论区进行讨论学习一下!

你可能感兴趣的:(Git系列,git,github)