Git

Branch

Create and Switch

创建分支（默认创建一个指向当前commit的分支）
git branch <branch_name>
切换分支（等价于：）
git checkout/swtich <branch_name>
git switch -c <branch_name>
git checkout -b <branch_name>

Merge

一般用得较多的就是对远程仓分支和本地仓分支的合并 merge ，merge有几种情况，一种是不需要解决冲突的，一种是需要解决冲突的

Remove

删除已合并（merge）的分支
git branch -d <branch_name>
删除分支
git branch -D <branch_name>
删除远程分支
git branch -r -D <branch_name>

Config

设置环境变量

设置身份验证cache状态 (保持验证状态5min)
git config --global credential.help 'cache --timeout 300'
取消cache状态
git config --global unset credential.help
配置commit时的IDx信息
git config --global user.name  "spongebob"
git config --global user.email "spongebob@mail2.gdut.edu.cn"
配置push / pull时远程仓时使用的代理服务
git config --global http.proxy 127.0.0.1:12333
git config --global https.proxy 127.0.0.1:12333
设置默认文本编辑器
git config --global core.editor vim

NOTE

git的环境变量可存在于三个配置文件下，其中的环境变量适用对象不同

/etc/gitconfig：适用于linux 系统所有用户。--system
~/.gitconfig：适用于当前登录用户。--global
.git/config：位于和适用于本地仓。--local(default)
对于同一环境变量，三个配置文件对环境变量覆写的优先级是1<2<3

查看配置参数

git config --list or -l
--show-origin: 查看来源（配置文档路径）

查看当前配置参数的来源

git config -l --show-origin
>>>
file:/home/helios/.gitconfig   core.editor=vim
file:/home/helios/.gitconfig   core.autocrlf=input
file:.git/config     core.repositoryformatversion=0
file:.git/config     core.filemode=true
file:.git/config     core.bare=false
file:.git/config     core.logallrefupdates=true
file:.git/config     submodule.active=.
<<<

Diff

CLI

git diff
使用图形化界面meld查看（逐文件查看）
git difftool --tool meld
使用图形化界面meld查看（基于文件夹查看）
实际上等价于meld .
git difftool --tool=meld --dir-diff
配置全局默认的图形工具
git config --global diff.tool meld
是否需要prompt来看下一个文件
git config --global difftool.prompt false

Meld 

Delta 

基于终端的diff（可分两列显示）

wget -c https://github.com/dandavison/delta/releases/download/0.13.0/git-delta_0.13.0_amd64.deb

GitUI 

基于终端的diff（可视化效果更好，但暂无side by side功能）

解压后挪到/usr/local/bin等位置
wget -c https://github.com/extrawurst/gitui/releases/download/v0.20.1/gitui-linux-musl.tar.gz
gitui

Gist

以下两种Gist客户端的核心功能差不多，后者的登录时间较长，然后感觉后者的UI比前者更好看。都不支持离线管理。（暂无找到支持离线管理的）

Install

Gisto 

sudo snap install gisto

Lepton 

sudo snap install lepton

Gh

Install 

curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
sudo apt update
sudo apt install gh

Hook

git hook是一个脚本（bash或者python均可），是执行一些git的操作前或者操作后需要运行的脚本
hook可以根据触发的时机分为两类：客户端(clien-side)或者服务端(server-side)，前者如git commit/merge，后者如服务端接收到推送的commit
执行git init后会有一系列的hook模板在.git/hooks下生成，以供参考，可以在此基础上进行修改

~/.git/hooks$ tree
.
├── applypatch-msg.sample
├── commit-msg.sample
├── fsmonitor-watchman.sample
├── post-update.sample
├── pre-applypatch.sample
├── pre-commit.sample
├── pre-merge-commit.sample
├── prepare-commit-msg.sample
├── pre-push.sample
├── pre-rebase.sample
├── pre-receive.sample
└── update.sample

注意

使用前面提到的 git/hook 中的脚本，并不能同步到远程仓

Ignore 

要对某些文件不进行版本管理，可将其加入到配置文档中，相应的配置文件为 .git/info/exclude 和 .gitignore ，前者为 git init 时创建；后者一般上传至远程仓，跟别人共享一份配置
J家 IDE可以用.ignore插件来生成.ignore模板文件
.ignore中的一些语法：遵从通配符模式找文件，默认递归地查找工作空间的文件；开头加上/表示取消递归

Info

CLI

查看当前仓库的状态（如是否有文件未提交）
git status
简略版本
git status -s
查看历史记录（逆序输出，最新的在前面）
git log
-<num>:   显示前几次的commit信息
-p / --patch:  显示difference信息（这一次和上一次做了哪些修改）
查看annotation
git blame <file_name>
查看当前的commit ID（revision）
git rev-parse HEAD

Pycharm

annotation for pycharm

Rm

删除文件

一般可用来解决如下报错： already exists in the index

删除在暂存区和工作区的相关文件和文件夹
git rm <文件/文件夹>
只删除其在暂存区的相关文件和文件夹
git rm --cached <文件/文件夹>

备注

git rm 只能删除已在暂存区的文件

移除未被管理的文件

从工作空间中清除没参与版本管理的文件（remove untracked files from the working tree）

git clean
-q, --quiet           不打印删除的文件名
-n, --dry-run         dry run
-f, --force           force
-i, --interactive     交换式的清除，有选择项
-d                    清除因此而空的空目录
-e, --exclude <pattern> add <pattern> to ignore rules
-x                    连带删除被ignore的文件
-X                    只删除被ignore的文件

从历史树移除数据 

BFG

以下说明一个github官方推荐的工具 BFK ，不同于官方教程的 git clone ，此处推荐直接下载jar包

其相关的功能包括：删除大文件、删除包含某些敏感信息的文件、删除某个文件夹。具体的使用可参考简书example，官方实例，不赘述

同时删除多个文件夹
bfg --delete-folders "{List of folder separated by comma}" <file path for Git repository to clean>

注意

BFG并不能删除特定的文件夹和文件，只能删除同名的文件夹和文件。要实现上述目的，可以使用git filter-repo

git filter-repo 

CLI

安装
pip3 install git-filter-repo
去到git工作空间
cd ~/Sleipnir/
To remove ~/Sleipnir/data/ from every revision in history:
使用的为相对路径
git filter-repo --invert-paths --path data/
更新远程仓
git push origin --force --all
更新本地仓（触发回收机制）
git for-each-ref --format="delete %(refname)" refs/original | git update-ref --stdin
git reflog expire --expire=now --all
git gc --prune=now

备注

--invert_paths 需要和 --paths 一起使用的，单纯 --paths 指的是保留，否则是反选

参考资料

Precommit 

使用gitcommit可以生成本地的git hook

安装
pip install pre-commit
run pre-commit install to set up the git hook scripts
pre-commit install
手动触发precommit
pre-commit run --all-files

案例

Login

Personal Access Token 

备注

注意若登录失效，或检查一下token是否过期

Ssh 

http使用push和pull都需要显式在命令行输入口令（账号、密码），ssh则不用

或涉及的命令行操作

显示现有ssh密钥（公钥后缀为pub）
ls -al ~/.ssh
生成新ssh密钥（可以不加-t，默认选项为rsa）
ssh-keygen -t ed25519 -C "github电子邮件地址"

添加ssh公钥于github
测试git hub ssh连接

ssh -T git@github.com

Remote

显示和配置本地仓的远程仓属性

显示 usl alias/shortname
git remote
-v: show url <=> 等价于 git remote get-url <alias>
重设远程仓url
git remote set-url <name> <newurl>
重命名远程仓别名
git remote rename <old> <new>
git remove rename origin main

从远程仓拉取数据

git fetch <url/alias>

剔除本地仓与远程仓的关联

git remote remove origin

覆写本地仓

根据远程仓覆写本地仓

获取远程仓的历史树
git fetch
版本回溯
git reset --hard <remote_branch_name>

上传本地仓数据到远程仓

git push <url> branch

覆写远程服务器上的git仓

在本地修正完本地仓的历史后，强制将本地仓的历史覆写到远程仓中（暴力解决方案）

git push -f

Submodule

参考man gitsubmodules

移除子仓库在.gitlink和.gitmodules中相关的元数据、还有其工作空间
git rm <submodule path> && git commit
手动移除子仓库的git文件
rm -rf <GIT_DIR>/modules/<name>

本地仓添加子仓

git submodule add <url> [待添加的工作路径]

本地仓克隆子仓

git clone <url>
git submodule init --recursive
或者直接一步到位
git clone <url> --recursive

vcstool 

该工具用于替换git submodule来管理子模块（实测，在国内使用体感不太好，容易下载失败）
autoware example

sudo apt install -y python3-vcstool
vcs import src < autoware.proj.repos

Travel In Time

取消待进行的merge操作

有时暂时不想解决文件冲突问题，想取消merge操作，还原之前的状态

--abort abort the current in-progress merge
git merge --abort

备注

有时不解决文件冲突则无法进行某些操作，比如 reset --soft 操作

回溯到某个commit

git checkout <commit_id>

修改最近的提交说明

当本地文件内容 = 暂存区内容 = 本地仓内容时，修改上一次的commit message

git commit --amend -m "<修改后的message>"

Reset

Reset current HEAD to the specified state

回溯到对应的commit
git reset [option] [commit_id]
--soft  ：同步HEAD(difference不会commit)
--mixed ：同步HEAD和INDEX区(difference会commit)
--hard  ：同步HEAD、INDEX和工作空间

reset --hard一般可用于删除commit，如删除当前的commit

git reset --hard HEAD~1

reset --soft一般用于修正历史树(commit tree)，如让其线性化

Revert

通过提交一个commit去撤销某次commit

还原

将文件移除暂缓区，可先看git status
git restore --staged <file>

Practice

私人仓添加成员 

已删工程无法push 

project is already on GitHub

对文件内容进行选择性commit 

README

typora上传的图片在github上不能缩放（使用了不支持的属性）

几种图片格式方案：

gif图片无法显示：链接的gif图不能超过5Mb

Git

Branch

Create and Switch

Merge

Remove

Config

设置环境变量

查看配置参数

查看当前配置参数的来源

Diff

CLI

Gist

Install

Gh

Hook

Info

CLI

Pycharm

Rm

删除文件

移除未被管理的文件

BFG

参考资料

Login

Remote

显示和配置本地仓的远程仓属性

从远程仓拉取数据

剔除本地仓与远程仓的关联

覆写本地仓

上传本地仓数据到远程仓

覆写远程服务器上的git仓

Submodule

本地仓添加子仓

本地仓克隆子仓

Travel In Time

取消待进行的merge操作

回溯到某个commit

修改最近的提交说明

Reset

Revert

还原

Practice

README

Reference