团队研发文档

开发规范、技术文档等


Git常用指令与操作

<h3>版本记录</h3> <table> <thead> <tr> <th>版本号</th> <th>版本说明</th> <th>作者</th> <th>日期</th> <th>备注</th> </tr> </thead> <tbody> <tr> <td>V1.0</td> <td>Git常用指令与操作</td> <td>Meeler</td> <td>2018-08-22</td> <td>修订版</td> </tr> <tr> <td>------------</td> <td>------------</td> <td>------------</td> <td>------------</td> <td>------------</td> </tr> </tbody> </table> <hr /> <h2>Git 常用命令</h2> <p><strong>新建代码库</strong></p> <pre><code>`git init` 在当前目录新建一个Git代码库 `git init [project-name]` 新建一个目录,将其初始化为Git代码库 `git clone [url]` 下载一个项目和它的整个代码历史</code></pre> <p><strong>配置</strong></p> <pre><code>`git config --list` 显示当前的Git配置 `git config -e [--global]` 编辑Git配置文件 `git config [--global] user.name "[name]"` 提交代码时用户名称 `git config [--global] user.email "[email address]"` 提交代码时用户邮箱</code></pre> <p><strong>增加/删除文件</strong></p> <pre><code>`git add [file1] [file2] ...` 添加指定文件到暂存区 `git add [dir]` 添加指定目录到暂存区,包括子目录 `git add .` 添加当前目录的所有文件到暂存区 `git add -p` 同一文件的多处变化,实现分次提交 `git rm [file1] [file2] ...` 删除工作区文件,且将此删除放入暂存区 `git rm --cached [file]` 停止追踪指定文件,该文件会保留在工作区 `git mv [file-original] [file-renamed]` 改文件名,并且将这个改名放入暂存区</code></pre> <p><strong>代码提交</strong></p> <pre><code>`git commit -m [message]` 提交暂存区到仓库区 `git commit [file1] [file2] ... -m [message]` 提交暂存区的指定文件到仓库区 `git commit -a` 提交工作区自上次commit之后的变化,直接到仓库区 `git commit -v` 提交时显示所有diff信息 `git commit --amend -m [message]` 使用一次新的commit,替代上一次提交 `git commit --amend [file1] [file2] ...` 重做上一次commit,包括指定文件的新变化</code></pre> <p><strong>分支命令</strong></p> <pre><code># 列出所有本地分支 `git branch` # 列出所有远程分支 `git branch -r` # 列出所有本地分支和远程分支 `git branch -a` # 新建一个分支,但依然停留在当前分支 `git branch [branch-name]` # 新建一个分支,并切换到该分支 `git checkout -b [branch]` # 新建一个分支,指向指定commit `git branch [branch] [commit]` # 新建一个分支,与指定的远程分支建立追踪关系 `git branch --track [branch] [remote-branch]` # 切换到指定分支,并更新工作区 `git checkout [branch-name]` # 切换到上一个分支 `git checkout -` # 建立追踪关系,在现有分支与指定的远程分支之间 `git branch --set-upstream [branch] [remote-branch]` # 合并指定分支到当前分支 `git merge [branch]` # 选择一个commit,合并进当前分支 `git cherry-pick [commit]` # 删除分支 `git branch -d [branch-name]` # 删除远程分支 `git push origin --delete [branch-name]` `git branch -dr [remote/branch]`</code></pre> <p><strong>标签命令</strong></p> <pre><code># 列出所有tag `git tag` # 新建一个tag在当前commit `git tag [tag]` # 新建一个tag在指定commit `git tag [tag] [commit]` # 删除本地tag `git tag -d [tag]` # 删除远程tag `git push origin :refs/tags/[tagName]` # 查看tag信息 `git show [tag]` # 提交指定tag `git push [remote] [tag]` # 提交所有tag `git push [remote] --tags` # 新建一个分支,指向某个tag `git checkout -b [branch] [tag]`</code></pre> <p><strong>查看信息</strong></p> <pre><code># 显示有变更的文件 `git status` # 显示当前分支的版本历史 `git log` # 显示commit历史,以及每次commit发生变更的文件 `git log --stat` # 搜索提交历史,根据关键词 `git log -S [keyword]` # 显示某个commit之后的所有变动,每个commit占据一行 `git log [tag] HEAD --pretty=format:%s` # 显示某个commit之后的所有变动,其"提交说明"必须符合搜索条件 `git log [tag] HEAD --grep feature` # 显示某个文件的版本历史,包括文件改名 `git log --follow [file]` `git whatchanged [file]` # 显示指定文件相关的每一次diff `git log -p [file]` # 显示过去5次提交 `git log -5 --pretty --oneline` # 显示所有提交过的用户,按提交次数排序 `git shortlog -sn` # 显示指定文件是什么人在什么时间修改过 `git blame [file]` # 显示暂存区和工作区的代码差异 `git diff` # 显示暂存区和上一个commit的差异 `git diff --cached [file]` # 显示工作区与当前分支最新commit之间的差异 `git diff HEAD` # 显示两次提交之间的差异 `git diff [first-branch]...[second-branch]` # 显示今天你写了多少行代码 `git diff --shortstat "@{0 day ago}"` # 显示某次提交的元数据和内容变化 `git show [commit]` # 显示某次提交发生变化的文件 `git show --name-only [commit]` # 显示某次提交时,某个文件的内容 `git show [commit]:[filename]` # 显示当前分支的最近几次提交 `git reflog` # 从本地master拉取代码更新当前分支:branch 一般为master `git rebase [branch]`</code></pre> <p><strong>远程同步</strong></p> <pre><code># 下载远程仓库的所有变动 `git fetch [remote]` # 显示所有远程仓库 `git remote -v` # 显示某个远程仓库的信息 `git remote show [remote]` # 增加一个新的远程仓库,并命名 `git remote add [shortname] [url]` # 取回远程仓库的变化,并与本地分支合并 `git pull [remote] [branch]` # 上传本地指定分支到远程仓库 `git push [remote] [branch]` # 强行推送当前分支到远程仓库,即使有冲突 `git push [remote] --force` # 推送所有分支到远程仓库 `git push [remote] --all`</code></pre> <p><strong>撤销</strong></p> <pre><code># 恢复暂存区的指定文件到工作区 `git checkout [file]` # 恢复某个commit的指定文件到暂存区和工作区 `git checkout [commit] [file]` # 恢复暂存区的所有文件到工作区 `git checkout .` # 重置暂存区的指定文件,与上一次commit保持一致,但工作区不变 `git reset [file]` # 重置暂存区与工作区,与上一次commit保持一致 `git reset --hard` # 重置当前分支的指针为指定commit,同时重置暂存区,但工作区不变 `git reset [commit]` # 重置当前分支的HEAD为指定commit,同时重置暂存区和工作区,与指定commit一致 `git reset --hard [commit]` # 重置当前HEAD为指定commit,但保持暂存区和工作区不变 `git reset --keep [commit]` # 新建一个commit,用来撤销指定commit # 后者的所有变化都将被前者抵消,并且应用到当前分支 `git revert [commit]` # 暂时将未提交的变化移除,稍后再移入 `git stash` `git stash pop`</code></pre> <p><strong>其他</strong></p> <pre><code>`git archive` 生成一个可供发布的压缩包</code></pre> <h2>Git 规范操作</h2> <p>以content pulse项目为例,主分支master,开发分支develop。</p> <p><strong>新开发v1.1版本,需要创建feature分支:</strong>develop-v1.1</p> <pre><code># 从 develop 分支建一个 feature 分支,并切换到 feature 分支 `git checkout -b develop-v1.1 develop`</code></pre> <p><strong>建立个人develop-v1.1-liuzheng分支</strong></p> <pre><code># 从 develop-v1.1 分支建个人开发分支develop-v1.1-liuzheng,并切换到个人开发分支 `git checkout -b develop-v1.1-liuzheng develop-v1.1`</code></pre> <p><strong>提交本地变更到远程develop-v1.1-liuzheng分支</strong>(个人分支不与他人共有,不会冲突)</p> <pre><code># 创建develop-v1.1-liuzheng 分支commit信息,并push到远程分支 `git commit -m '[WIP]个人开发功能提交'` `git push`</code></pre> <p><strong>develop-v1.1-liuzheng分支开发完成,合并到develop-v1.1分支</strong> <font color="red"><strong>不推荐</strong>:</font></p> <pre><code># 命令行先切换到develop-v1.1分支,将个人分支代码合并到develop-v1.1 `git checkout develop-v1.1` `git merge --no-ff develop-v1.1-liuzheng`</code></pre> <p><font color="green"><strong>推荐</strong>:</font></p> <pre><code>·先同步develop-v1.1分支代码到个人代码· # 首先提交个人代码,防止merge冲突时无法恢复 `git commit -m '[FEATURE]个人开发功能提交'` # merge前同步,保证代码最新 `git fetch` # merge develop-v1.1到默认当前个人开发分支develop-v1.1-liuzheng # 通过idea可以先比较再git pull或git merge `git merge --no-ff develop-v1.1` # 有冲突则解决冲突,而后commit,最后push,至此个人开发分支的代码是最完善的。 最后将个人分支`develop-v1.1-liuzheng`合并到`develop-v1.1`,应在gitlab上发起Merge Request,由他人review且没问题后才可合并。</code></pre> <p><strong>develop-v1.1分支所有功能开发完成,合并到develop分支</strong></p> <p><code>合并操作同上,合并完成后删除所有个人分支</code></p> <p><strong>从develop分支派生release分支:release-v1.1</strong></p> <pre><code>`git checkout -b release-1.1 develop`</code></pre> <p><strong>release-v1.1分支无误后合并到 master分支</strong></p> <p><code>合并操作同上,合并完成后给master分支打tag</code></p> <pre><code># 打tag `git tag -a v1.1.0`</code></pre> <p><strong>release-v1.1分支若有细微改动,合并到 develop分支</strong></p> <p><code>合并操作同上</code></p> <p><strong>确认版本已发布(合并入master分支)</strong>:删除 release-v1.1分支 和 develop-v1.1分支**</p> <pre><code># 删除 develop-v1.1分支 `git branch -d develop-v1.1` # 删除 release-v1.1分支 `git branch -d release-v1.1`</code></pre> <p><strong>Hotfix 分支</strong> <font color="red">操作同release分支,每次必须合并到develop和master分支,最后版本发布确认develop分支和master分支一致` </font></p>

页面列表

ITEM_HTML