关于Git与GitHub的一些心得

软件开发者对Git不会陌生，它是现代最受欢迎的开源分布式版本控制工具，典型使用场景下，多个客户端从中央仓库pull拉取代码副本，各自开发commit，再push到中央仓库。“分布式”的意思即各个客户端的开发互相独立，分布进行，只在需要时与中央仓库同步。

GitHub是一个基于Git的远程代码托管平台，开源社区的开发者把代码放在它上面十分便于分享协作，其免费私有仓库也可以作为本地工程的额外备份空间。工程之外，用Git管理文本天生可溯源，每一个文件的每一次修改提交都有记录，能在版本间灵活跳跃，撤销更改非常方便。我的个人笔记就是以Markdown文本存储在GitHub私有仓库中，再搭配一款文本编辑器来组成最适合自己的跨平台笔记系统。

如何使用GitHub是一个很基础的问题，但就像刚接触Vim一样，初始操作是一切可能性的开始，其中一些问题值得单独拿出来记录。

你是谁

远程仓库在与本地建立关联后，本地push会更改它所托管的内容，所以身份验证十分重要，只有被验证拥有权限的用户才能执行操作。

GitHub鉴权有三种方式，常规的用户名+密码、服务端生成的授权token和基于非对称加密的SSH key。

用户名+密码

默认情况下，如果链接远程仓库是通过https://github.com/*而非SSH的git@github.com:*，向其push会触发git要求输入用户名+密码来验证身份。这种方式非常直观，但每次push都要求重新输入验证。

如果要git记住用户名和密码，需要为每个仓库逐一设置git config，这样身份信息就会被保存给之后复用。

# 在每个仓库目录下执行
git config --global credential.helper store

授权token

授权token在GitHub中配置生成，可以指定权限范围，包括从访问用户仓库列表到创建、删除仓库在内的一系列危险操作。它和用户名+密码一样通常被IDE使用以在本地管理远程仓库，比如IntellJ IDEA在创建工程时就可以直接从用户的GitHub仓库中clone。

SSH key

相比之下，基于非对称加密的SSH key则是一种更方便的无密码验证方式。只需要用ssh-keygen生成一对密钥，私钥保存在本地，公钥上传到GitHub，鉴权时一端发送一段密文，如果另一端能够解密即验证成功。

使用这种机制要求指向远程仓库的链接是符合git@github.com:*的SSH格式。

建立关联

曾经有一段时间如何正确的把本地仓库和远程仓库建立关联让我十分费解，不过现在一切都清晰明朗，用几种典型情况来说明。

克隆

最常见也最简单的一种场景是clone一个GitHub仓库到本地，这种情况下本地仓库是自动与该远程仓库绑定的，仓库目录下执行git remote -v就能看到名为origin的远程仓库。

# 查看远程仓库
git remote -v
# 输出
origin	https://github.com/apqx/apqx.github.io.git (fetch)
origin	https://github.com/apqx/apqx.github.io.git (push)

应当注意，clone的是远程仓库的默认分支，如果要访问其它分支需要手动从远程分支创建，这样新建的本地分支也自动与它所基于的远程分支相关联。

# 基于远程的origin/dev分支，在本地创建一个dev分支
# 则本地dev分支自动与该远程分支相关联
git branch dev origin/dev
# 切换到dev分支后，其commit会被正确push到对应的origin/dev分支
git checkout dev
git push

本地仓库目录下有一个隐藏的.git目录，里面存储着当前仓库的git配置信息，在.git/config中可以看到链接的远程仓库。

[remote "origin"]
	url = https://github.com/apqx/apqx.github.io.git
	fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
	remote = origin
	merge = refs/heads/master

一个小技巧是可以把这个.git目录复制到任何一个目录下，则该目录就变成了一个链接对应远程仓库的本地git仓库。git会检查当前目录相对于HEAD所指向commit版本的文件变化，等待用户新的commit提交。

手动关联

另一个常见场景是在本地创建git仓库，想把它托管到GitHub上，应该如何操作？

首先为本地工程创建git仓库。

# 工程根目录下，初始化git，创建一个本地git仓库
git init

进行开发并commit提交代码。

# 把指定文件及其修改添加到git记录中
# 这里的`.`表示目录下所有文件，应配合.gitignore排除不记录的二进制文件
git add .
# commit提交
# 应注意只有进行过commit的仓库，其分支才可以链接
git commit -m "First commit"

与远程仓库建立关联分为2步，添加远程仓库和把本地分支与远程分支相关联。

在GitHub上创建远程仓库时不要选择添加.gitignore和README.md，会导致其自动为这两个文件的创建产生commit记录，没有必要，在本地仓库添加它们更合适。

从某个时间节点开始，GitHub创建的仓库默认是main分支，而本地创建则默认是master，为保持一致建议在本地有过commit之后修改master分支名为main。

# 本地有过commit记录后，master分支是有效的
# 重命名为main
git branch -m master main

建立关联的第1步先添加远程仓库，注意如果要配合SSH key免密码鉴权需要使用类似git@github.com:apqx/*的SSH格式。

# 为本地仓库添加远程仓库，并命名为origin
# 这种URL格式可以使用SSH key免密码鉴权
git remote add origin git@github.com:apqx/apqx.github.io.git
# 拉取远程仓库的可读信息，这个操作是必要的，否则本地看不到远程仓库的分支
git fetch

# 可以查看已添加的远程仓库
git remote -v
# 可以查看所有远程仓库的分支
git branch -r

第2步将本地分支与远程分支建立关联，根据远程分支是否存在分为2种情况。

# 一，远程仓库不存在该分支，比如main，在远程仓库没有commit记录的情况下是不存在的
# 即创建仓库时没有选择添加.gitignore或README.md时，main分支不存在
# 就可以直接将本地当前分支push到指定的远程分支上，因为该分支不存在，所以会被自动创建
# 同时这2个分支也自动建立关联
git push -u origin main

# 二，远程仓库存在该分支，比如main
# 则不能直接把本地分支push到指定的远程分支上，需要先处理冲突
# 设置本地分支对应的远程分支，本地main对应远程的origin/main
git branch --set-upstream-to=origin/main main
# 拉取远程分支的commit信息，与本地合并，需要处理可能的冲突
# 第一次拉取时要加上--allow-unrelated-histories，来允许合并这2个本来毫无关联的分支信息
git pull --allow-unrelated-histories
# 执行完成后2个分支就建立了关联，可以正常pull、push

如果本地新增分支，也可以像上面第1种情况那样直接push到远程仓库里。

# 比如本地有一个新的dev分支要push到远程仓库
# 切换到该分支
git checkout dev
# push到远程仓库的dev分支中
# 因为远程仓库不存在该分支，所以不会有冲突，自动在远程创建并建立关联
git push -u origin dev

删除本地分支和远程分支也很简单。

# 删除指定的本地分支
git branch -d <branch-name>
# 删除指定的远程分支
git push origin --delete <branch-name>

尾声

GitHub在被微软并入后功能迭代更加活跃，已经在之前博文中提过Github Pages，再排除今天写的部分，还有一些如Fork和Action的功能没有涉及。最近计划的一个东西需要用到它们，做完也会把相关心得分享出来。