GitHub使用指南

创建本地仓库

• 创建一个新的本地仓库并提交（先在网页端创建远程仓库）

git init
git remote add origin https://xxx.git
git add .
git commit -m "first commit"
git push origin master

• 修改本地文件后，查看改动内容

git status
git diff my_file

• 当本地与远程冲突时，强制提交到远程仓库

git push origin master -f

更新本地仓库

• 获取远程仓库状态并更新至本地

git fetch --all
git pull

• 当本地与远程冲突时，把HEAD指向最新版本，强制覆盖本地

git reset --hard origin/master

下载仓库

• 下载仓库

git clone https://xxx.git

• 下载仓库的my_branch分支

git clone -b my_branch https://xxx.git

• 更新子模块

git submodule update --init --recursive

• 下载父仓库同时更新所有子模块

git clone -b branch_name https://xxx.git --recursive

配置本地仓库

• 查看config

git config --system --list
git config --global --list
git config --local --list

• 设置config

git config --global user.name "my_name"
git config --global user.email "my_email"

• 保存Git账号和密码至当前计算机（记录至~/.git-credentials）

git config credential.helper store
git push origin master

创建分支

• 查看所有分支

git branch

• 从当前分支创建新分支

git branch my_branch
git checkout my_branch

• 当头指针分离时，根据当前内容创建新分支

git checkout -b my_branch

• 删除分支

git branch -d my_branch

• 重命名分支并提交至远程

git branch -m old_name new_name
git push origin new_name
git push --delete origin old_name

• 当开发分支dev达到上线标准，要合并到主分支master

git add .
git commit -m "xxx"
git checkout master
git merge dev
git push

• 当主分支master改动，要更新到开发分支dev

git add .
git commit -m "xxx"
git checkout dev
git merge master
git push

创建子模块

• 添加子模块并拉取子模块的所有内容

git submodule add https://xxx.git
git submodule update --init --recursive

• 提交

# 在新功能包A中使用已存在功能包B时，应以子模块形式添加

# 当修改A中的B后，应先在B中提交，从而更新B仓库，然后在A中提交，从而更新A仓库，即修改一次需提交两次
# 建议在A中提交时，commit为“Update submodule B”

# 如果不希望在A中改动原有的B，则应该在添加子模块时，创建B的一个新的分支，建议以A命名

• 删除子模块

# rm -rf 子模块目录
# 修改.gitmodules
# 修改.git/config
# rm -rf .git/modules/子模块目录

使用cnpmjs镜像地址

• 将github.com改为github.com.cnpmjs.org
• 已经由github.com下载的本地仓库通过手动更改.git/config中的url重新定向至github.com.cnpmjs.org
• 已经由github.com下载的子模块通过手动更改在.git/modules/子模块目录/config中的url重新定向至github.com.cnpmjs.org

SSH密钥验证

• 从2021年8月13日开始，GitHub进行身份验证时不再接受帐户密码访问，只接受基于密钥（token）的身份验证，通过以下命令可以生成密钥

ssh-keygen -t rsa -C "email@email.com"

• 默认状态下，密钥将保存至~/.ssh/id_rsa.pub，只需复制其中的内容至网页版GitHub账号的SSH keys中，即可实现本地与GitHub仓库的配对
• 使用密钥验证时，.git/config中的url应重新定向至git@github.com:user_name/repo.git，通过以下命令可设置url

# 查看url
git remote -v
# 修改url
git remote set-url origin git@github.com:user_name/repo.git