Idea新建项目并推送到远程仓库

Idea新建项目并推送到远程仓库

1.前言

最近在公司负责小型的项目开发，使用SpringBoot搭建一个小型服务，并推送到GitLab上供其他组员进行再次开发。

在开发过程一路踩坑一路填坑，最终在交付期顺利完成任务，所以私下又手撸一个多模块的SpringBoot项目搭建过程加深印象，这里就记录一下搭建完成后加入Git版本记录以及推送到远程仓库的过程。

2.初始化本地仓库及提交项目到本地仓库

一个初步搭建好的基础框架，这里我以自己搭建Beta项目作为演示，将它加入Git版本管理，并推送至Gitee来模拟在公司中搭建项目推送至GitLab的过程。

2.1.借助Idea的Git版本控制快速初始化项目为本地仓库

idea只要配置好了Git版本控制，就可以利用图形界面快速初始化项目

操作步骤：VCS -> Import into Version Control->Create Git Repository

2.2.查看项目是否初始化本地仓库成功

如何查看项目是否初始化成一个仓库呢，可以有以下办法：

1. 可以去到项目的目录下查看是否又隐藏的文件.git文件夹，有这个文件夹证明Git已经对它进行了版本控制了。
2. 观察Idea项目的一些文件是变成红色，因为加入版本控制后，项目中的未提交到暂存区都是会变红的。

2.3.创建git忽略提交的文件.gitignore

这个文件是记录一些不需要提交到仓库的文件，比如Idea自带的.iml文件，编译后target文件夹等等，这些都是不需要提交到仓库中。

这是因为当其他组员拉下项目时，导入到他们的IDE环境时会自动构建这些文件，如果提交上去不但占用远程仓库的空间，还有可能导致其他人的导入项目容易出错，之前我司就出现类似的情况，比如有些人使用的eclipse，你用的是idea，这样容易造成冲突。

.gitignore内容如下：

如果没有创建项目时，没有自动生成该文件，这里可以复制一下下面常用的Java忽略提交的文件内容

HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/

### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache

### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr

2.4.将整个项目存储到本地暂存区

前面创建好需要git忽略提交的文件，剩下的文件以及目录就是需要全部推送到远程仓库的东西。因为我们需要将工作区所有文件（也就是我们能看到的目录文件）先添加到本地暂存区，然后再提交到本地仓库，最后再推送到远程仓库中。

这里附带一张Git的基本工作流程图

本教程只会用到图中最下面的流程图：1->2->3

操作步骤：选中整个目录，然后在IDEA的顶部菜单中依次操作VCS -> Git->Add

操作过后，就可以看到之前变红的文件已经变绿了，这说明已经成功添加到暂存区。然后在IDEA的顶部菜单中依次操作VCS -> Git->Commit File就能看到本地暂存区所有的文件列表

或者你的idea是2021版本，也可以点击最左侧边栏commit按钮查看所有暂存区所有的文件列表

2.5.提交所有文件到本地仓库

选中所有的文件之后，需要填写提交的信，这里建议按照Git规范进行提交。我这里使用feat:表明这是新功能的开发提交规范，后面就是具体的提交信息init project，如果公司没有这样的规范就可以随意。

然后点击commit按钮提交即可，当中可能会弹出code analysis警告，我们就选commit anyway即可，提交完成后，整个暂存区的列表被清空，提交后的文件也会从绿色变成普通的灰色。

3.创建远程仓库及推送文件到远程仓库

3.1.创建与项目同名的仓库

这里的仓库是使用Gitee码云的仓库来作为远程仓库，一般公司会有自己的私有仓库像GitLab这样。其实包含创建仓库的流程也可以在idea中完成，但是实际工作中仓库一般是公司的管理员或者直属上级创建好，甚至要求严格的公司还对分支及推送有权限设定。

所以这里我就先建空白仓库，然后模拟直接把写好的初始化项目推送到Gitee来模拟在公司将项目推送到GitLab的一个流程。

创建好的Gitee远程仓库如下

3.2.本地仓库和远程仓库进行关联

接下来就是将本地仓库和远程仓库进行关联，并将本地仓库推送到远程仓库。如果前面的步骤都顺利完成，那么你的项目的目录就已经是一个本地仓库。而我们在远程创建的仓库其实可以理解为远程的一台电脑同名项目目录。

那么接下来要做的事情就很简单，可以理解为本地项目目录与远程项目目录建立微妙的关系。然后本地目录的文件拷贝粘贴到远程项目目录。

在Gitee的仓库也有类似的教程，只不过是命令行的形式，本文还是借助Idea以图形界面形式来完成最后两步。

idea中将本地仓库与远程仓库进行关联的操作步骤

在IDEA的顶部菜单中依次操作VCS -> Git->Remotes

在弹出的窗口Git Remotes中右侧+号按钮，来新增一个远程仓库关联，填入URL即可

3.3.推送本地仓库文件到远程仓库

在IDEA的顶部菜单中依次操作VCS -> Git->Push

之后就会弹出推送到远程仓库文件确认的窗口，选择push按钮提交即可，可能推送的过程要求输入账户和密码，按要求输入即可，通过验证即可推送，这里我之前验证过账户密码，所以就不记录这些步骤。

3.4.查看推送状态和历史记录

如果推送成功Idea右下角就出现Pushed master to new branch origin/master的提示。

然后选中项目，在IDEA的顶部菜单中依次操作VCS -> Git->Show History就可以查看提交版本历史记录

提交版本历史记录如下

4.编写及提交README.md文档

4.1.编写项目说明文档

一个项目必不可少的是项目说明文档，这里我推送完成后才发现漏掉了，但又觉得这个环节不能省略，故此在此补充一下，按照我司的规范约束，粗略写了一下。

4.2.推送项目说明文档

推送完项目后之后的文件推送到远程仓库就很简单了，选中要推送的文件依次执行Add和Commit File即可

4.3.查看远程仓库是否成功推送

至此完成使用Idea将一个新建的项目加入版本控制并推送到远程仓库的教程