Setup

Configuration

git config --global user.name "Username"
git config --global user.email "email"
git config --global color.ui true
git config --global core.editor vim
git config --global merge.tool opendiffgit config --global core.autocrlf input # Fix windows line endings that get introduced，把CR/LF全部換成LF，linux用
git config --global core.autocrlf true # 進入當前目錄時會換成window的CR/LF，進到commit時會自動換成LF，window用
git config --global core.autocrlf false # window only project

git config --list  # 檢視所有設定
git config --global alias.co checkout
git config --global alias.br branch
git config --global alias.ci commit
git config --global alias.st status
git config --global alias.unstage 'reset HEAD --'
git config --global alias.last 'log -1 HEAD'
git config --global alias.lol "log --graph --decorate --pretty=oneline --abbrev-commit --all"
git config --global alias.mylog "log --pretty=format:'%h %s [%an]' --graph"
git config --global alias.pushall "push --recurse-submodules=on-demand"    # 在parent repo push 時可以 push 所有submodule

// --global是此user，存在~/.gitconfig
// --local是此repo，存在repo的.git/config
// --system是所有user

查看說明

git xxx help                 # 查看xxx指令的說明，說明檔已經寫得很詳細，以下僅列出常用的指令之說明

Git commands

裸裝與平裝的分別

git init project #單人使用(平裝)
git init --bare project.git #多人使用(裸裝)

glt clone

git clone /var/git/project.git/                                   # 複製本機的repository
git clone ssh://[email protected]:/var/git/project.git/            # 複製外部的repository
git clone -o origin ssh://[email protected]:/var/git/project.git/  # 為遠端repo取名(預設為origin）

git diff

git diff             # 比較未 staging 與所在 branch 中最後一個 commit,等同 git diff HEAD
git diff --cached    # 比較 staging area 跟 Repo
git diff HEAD^       # 比較未 staging 與 Repo中倒數第二個 commit

想看先前的版本間差異

git log --oneline    #先顯示 log,方便後續操作
git diff SHA1..SHA2
git diff --since=1.week.ago --until=1.minute.ago

git reset

git reset (HEAD)             # 與 git add 功能相反，取消 staging 的狀態回到 unstaging 或 untracked
git reset (HEAD) filename    # 指定特定檔案從 staging area 狀態回到 unstaging 或 untracked

# 若最後一次commit有一些小錯誤要修正，想把修改之後的結果放入同一次commit
git add file_changed
git commit --amend -m "message"
git commit -a -m "message"   # 同上

# 如果想把 commit 撤銷，但不要回到unstaging或untrack，而是回到staging，可加--soft
git reset --soft <commit>    # 把 HEAD 指向該 commit，相應的結果為此commit之後的修改都回到 staging

# 如果要讓工作目錄與 commit 完全相同，可加--hard
git reset --soft HEAD^       # 把最後一次 commit 的檔案回復到 staging 並取消最後一次 commit
git reset --hard             # 把當前目錄和 staging 與最後一次 commit(HEAD) 同步，未追蹤的資料不會變化
git reset --hard <commit>    # 把 commit 之後的記錄完全撤銷並且將當前目錄與 commit 同步
git reset --hard HEAD^       # 取消最後一個 commit 並且將專案目錄回復到上一個 commit 的樣子

git revert

git revert <commit>          # 對該 commit 所有更變逆操作，做成新的 commit

git checkout

git checkout .               # Recover all to repo version
git checkout -- filename     # 回復為repo中的版本
git checkout <branch>        # 切換到 branch 分支
git checkout v0.0.1          # 切換到具有'v0.0.1'的特定 commit
git checkout -b <branch>     # 建立分支並切換到該分支 (常用）

# 處理遠端 branch
git checkout -b branch_name origin/<branch>    # 在origin/branch的基礎上創建一個新分支並切換過去
git checkout --track origin/<branch>           # 功能同上，小孩子不要學，學了也會忘

git branch --set-upstream master origin/next   # 把本地的master追蹤到origin/next

git remote

git remote                            # 列出所有遠端repo (-v可看網址）
git remote add <name> <address>       # 新增一個遠端 Repo
git remote rm <name>                  # 刪除遠端 Repo
heroku create                         # 創建新的遠端 Repo 於 Heroku 上並且在本地加入遠端 Repo
git remote update origin --prune      # 更新本地的 remote branche

git remote show origin                # 做下列三件事

# 1. 顯示所有 origin 中的 remote branch 及追蹤狀態
# 2. 顯示所有 local 及它們與 remote branch 的關係(使用git pull會發生的事)
# 3. 顯示所有 local 及它們與 remote branch 的關係(使用git push會發生的事)

git fetch

git fetch origin                  # 抓下遠端repo所有記錄
git fetch origin <branch>         # 只抓特定分支，取回的分支，在本地命名為origin/<branch>
git fetch -p                      # 清理已經被刪除的 remote branch

git pull

以merge操作

# 完整格式
git pull origin <remote_branch>:<branch>    # 取回origin的remote_branch分支，與本地的branch合併

git pull origin <remote_branch>             # 如果要與當前的branch合併，可以省略冒號後的<branch>
git pull origin                             # 如果當前分支有追蹤某個遠端分支，可以省略遠端分支名
git pull                                    # 如果當前分支只有唯一的追蹤分支，則連origin也可省略

# git pull 會做兩件事
# 1. 同步遠端 Repo 所有內容至本機(git fetch)
# 2. 合併 origin/branch 至當前分支(git merge origin/master)

# 此時 master 多一個 commit
# 加上新的commit後， origin/master 還不知道這個新的 commit
git push                                    # origin/master 與 master 指到相同位置,並且上傳至遠端 Repo

以rebase操作

git pull --rebase
# 會做兩件事
# 1. 同步遠端 Repo 至本機(git fetch)
# 2. rebase origin/master (git rebase origin/master)

git push

git push origin <branch>:<remote_branch>    # 對照git pull，冒號的意思就是從左邊送到右邊
git push origin :<remote_branch>            # 因為把branch設為空，表示刪除遠端分支（之後用git fetch -p刪除）
git push -u origin <branch>                 # 上傳當前分支到遠端 Repo，並將origin設為默認遠端

git push --tag                              # 為遠端 Repo 加上 tag（預設不會push tag，要用此指令才會）

情境：merge發生conflict

git pull     # 在合併時會出錯
git status   # 該文件會顯示 both modified
# 修改該文件...
git commit -a
git push

情境：rebase發生conflict

git fetch
git rebase   # 預設會去rebase origin/branch_name

# 碰到衝突有三種處置方法
# 1. 解決衝突後`git add .`再`git rebase --continue`
# 2. 跳過 master 上的這個 commit `git rebase --skip`
# 3. 回復到使用 rebase 前的狀態 `git rebase --abort`

git rebase

Rebase 真正含義

首先，當前的 branch 是從某個 commit 分出來的，那個 commit 就是此 branch 的 base。

Rebase 時,先把當前 branch 的最後一個 commit 到 base commit 間的所有 commits 移到暫存資料區，再把HEAD指向要被 rebase 的目標（也就是跑了所有的新的base的commit）,再將暫存區中的 commit 一一 commit 回來

假定現在要從某 branch 做 rebase master

git checkout <branch>           # 切到該branch
git rebase master               # 先在本 branch 上跑 master 的 commit, 再跑 branch 上的 commit
git checkout master
git merge <branch>              # 用此指令會是 fast-forward，只有一支
git merge <branch> --no-ff      # 不用 fast-forward 的情況下，會產生新的 merge commit，一個 merge 就代表一個 feature 的完成

# 進階用法
# https://git-scm.com/book/zh-tw/v1/Git-%E5%88%86%E6%94%AF-%E5%88%86%E6%94%AF%E7%9A%84%E8%A1%8D%E5%90%88
# server的base在master，client的base在server，要想直接rebase client到master
git rebase --onto master server client  # 如此會從client的base以後重演commit在master上
git rebase master server                # 在client和master後重演commit

有了這層認識後，git pull --rebase就不難理解了。

當使用git rebase --rebase時，會找到當前 branch 的 origin/branch，origin/branch 和 local branch 有各自的更新，但是當前 branch 的 base 就是在上一次git pull的地方。所以會把 pull 後的 local commit 先移到暫存區，再跑所有的origin/branch 的 commit，最後再把暫存區的 commit 回來。

參考ihower的說明

git rebase -i (Interactive rebase)

在同一個分支裡跑 rebase 是在更改 commit 順序

# rebase 到 HEAD^
git rebase -i HEAD^      # 因為 HEAD^ 之後只有一個commit,故只會有一個 commit 出現，所以其實不會改變順序
git rebase -i HEAD~3     # 重跑最後三個 commit,會跑出 editor,編輯完後再執行該 editor
# 之後會進editor，編輯順序，不過要注意，最上面是最先會被commit的，儲存後就會rebase了，進入editor後可看說明更改順序和commnet，合併，拆解

git branch

git branch                  # 列出目前的 local branch
git branch -r               # 列出目前的 remote branch
git branch -a               # 列出目前的 local branch 和remote branch
git branch <branch>         # 建立一個分支 branch
git branch -d <branch>      # 刪除 branch 分支
git branch -D <branch>      # 強制刪除 branch 分支（有 commit 但未 merge 時用）
git branch --merged         # 列出已經合併的 local branch
git branch -r --merged      # 列出已經合併的 remote branch

git log

我比較常用GUI或是一開始設定的alias看log

git log --pretty=oneline                # 一個 commit 只顯示一行
git log --oneline -p`                   # 將所有 log 和修改過的檔案內容列出
git log --oneline --stat --summary      #  查每個版本間的更動檔案和行數
git log --oneline --graph               # 圖形化
git log --until=1.minute.ago            # 只顯示一分鐘前的所有 commit
git log --since=1.day(hour/month).ago   # 只顯示一天\(小時\/月\)以內的所有 commit

git tag (用於釋出版本)

使用時機：每次推向production時使用（除非是用CI）

git tag                               # 檢視所有 tags
git tag -a v0.0.3 -m "version 0.0.3"  # 加上tag
git tag -a v0.0.3 9fceb02 -m "msg"    # 為特定的commit增加tag
git push --tags                       # 將本地的所有tag推到為遠端 Repo
git checkout v0.0.1                   # 切換到具有'v0.0.1'的特定 commit
git show v0.0.3                       # 檢視 tag 的 commit 資料
git tag -d v0.0.3                     # 刪除本地 tag
git tag -d `git tag | grep -E '.'`    # 刪除本地全部的 tag
git tag -d $(git tag -l)              # 刪除本地全部的 tag
git push origin --delete $(git tag -l)# 將與本地同名的遠端 tag 刪除
git push origin :refs/tags/v0.0.3     # 刪除遠端 tag

# 刪除遠端全部 tag
git ls-remote --tags origin | awk '/^(.*)(s+)(.*[a-zA-Z0-9])$/ {print ":" $2}' | xargs git push origin

git blame

git blame filename --date short  # 關於此檔案的所有 commit 紀錄\(包含作者,日期,更動的行及其內容\)

建立遠端 branch

滿足條件

1. 須要別人協作自己的 branch
2. 存在超過一天的分支,想儲存在遠端 Repo

git checkout -b <branch>        # 建立並切換分支
git push origin <branch>        # 連結近端 branch 到遠端 branch 並追蹤
# 修改...
git commit -am "message"
git push                        # 會自動儲存到遠端 Repo 的該 branch
# 其他人只要 git pull 就可以同步了

git stash

正在分支編寫,臨時要去 master 救火

git stash save "message"   # 把目前還沒有 commit 的文件存到暫存區並且將工作目錄復原到最後一次 commit

# 救火完成後...
git checkout <branch>         # 切回剛剛寫到一半的分支
git stash apply               # 回到 stash 前的未 commit 狀態

# 進階stash
git stash save --keep-index   # 只把 staging 的檔案 stash
git stash save --include-untracked    上述指令只考慮 tracked file,如要把 untracked file 也 stash 要用這個

git stash -h                  # 可以查到所有功能
# 每次跑 stash 都會把 stash 存到 stash stack 中
git stash list                # 顯示所有 stash,從最新到最舊
git stash show                # 顯示最新的 stash 其中的變更內容
git stash apply stash@{1}     # 回復最新的 stash
git stash drop                # apply 後 stash 依然存在,使用此指令刪除最上層的 stash
git stash clear               # 清除所有 stash

# shortcut (常用）
git stash                     # git stash save
git stash apply               # git stash apply stash@{0}
git stash drop                # git stash drop stash@{0}
git stash pop                 # git stash apply; git stash drop;

清理遠端branch和本地的origin

git push origin :branch_name   # 刪除遠端分支
git remote show origin         # 可以看到被砍掉的 branch 狀態為 stale，此時local branch還在，但是 origin 裡的 branch 失去追蹤的branch了
git remote prune origin        # 清理 origin 中被沒有追蹤的分支，應該跟 git fetch -p 功用相同

git filter-branch

計算 repository 大小

git count-objects -vH

這些情況下會有檔案要從所有歷史中完全移除。

1. 違反著作權
2. 大檔案移除

可以使用BFG或filter-branch，BFG要安裝，filter-branch較慢

大檔尋找

git ls-tree -r -t -l --full-name HEAD | sort -n -k 4 | tail -n 10

git filter-branch --force --index-filter 'git rm --cached --ignore-unmatch PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA' --prune-empty --tag-name-filter cat -- --all

git for-each-ref --format='delete %(refname)' refs/original | git update-ref --stdin

git reflog expire --expire=now --all

git fsck --unreachable

git gc --prune=now

git cherry-pick

# 要把別的branch的特定commit複製一份到當前branch，複製過來的commit有不同的SHA
git cherry-pick 54ea45
# 要寫入不同的commit message
git cherry-pick --edit 54ea45
# 要把複數commit拉到staging area並且不要commit
git cherry-pick --no-commit 53131s 41235e
# 把原commit的SHA加進commit message中
git cherry-pick -x 54ea45
# 把當前的user資訊加進commit message
git cherry-pick --signoff 54ea45

git modules

A git repo inside a git repo

# 將某個repo抓下來當成submodule，資訊會寫在.gitmodules
git submodule add [email protected]:sub_m.git
git commit -m "Add sub_m submodule"

# 要修改submodule
cd sub_m                    # 先進入該 submodule
git checkout master         # Submodule抓下來後並不會切到特定的branch，要自行指定
# 修改...
git commit -am "made changes..."
git push                    # 將submodule推上remote repo
# 因為parent repo會指向先前的submodule未更動前的commit，所以要回到parent repo再更新
cd ..
git add sub_m
git commit -m "Update something in sub_m"
git push

# clone專案中有用submodule（剛抓下來submodule folder會是空的）
git submodule init          # 讀.gitsubmodule並寫入資訊到.git/config
git submodule update        # clone submodules
# 之後如果submodule有變化，跑 git submodule update 也會更新
# 特別注意！每次跑submodule update，都會把submodule變成headless，所以要再checkout master，

在 Heroku 部署 local 分支

# Heroku 只會部署 master
<commit position>:<remote branch>

git push heroku-staging local_branch:master   # 把 local 分支部署到 Heroku master

exclude (專屬自己的資料夾,不給別人看的)

.git/info/exclude
experiments/    # exclude folder
tutorial.mp4    # file
*.mp4                    # all file ended with .mp4

.gitignore (所有repo中都有的,要故意忽略的)

*.log

情境：要將本來在repo的檔案停止追蹤但不刪除

git rm --cached development.log    # 之後再加入.gitignore

Github

fork project workflow

# Update your fork

git remote add upstream <path_to_repo>   # Add remote for upstream (now we have origin, upstream)
git fetch upstream                       # Fetch changes (fetch from upstream)
git merge upstream/master master         # Merge them into master
git push origin master                   # Push to your remote

Issue

git commit -m "This message will show up at issue #1"

# 下述三個，當 commit 被 merge 回 master 時，會關閉 issue
git commit -m "Fixes #1"
git commit -m "closes #1"
git commit -m "resolves #1"

commit messges 七條準則

1. 標題和主體以空行分隔
2. 標題控制在50個字母內，至多72個
3. 標題首字字首大寫
4. 標題句尾不加句號
5. 使用祈使句，要滿足這樣的句式：If applied, this commit will
6. 主體也以一行72個字母為限
7. 使用主體解釋 what, why vs. how，說明為何做，之前是如何，現在變得如何

Early branch releases

為了滿足

1. 跨團隊間不共享機密資料
2. 減少釋出新版本過程的人為操作

暫列出以下步驟，使得可以用原專案 repository 直接釋出到另一個跨團隊共享的 repository 並限制機密資料的流出

Firstly, add release repository to current project git remote add ios <git-repository-url>

(On master branch)

1. Create tag (assuming iOS_v1.0)
2. Copy all files that are about to be released out from current project
3. Encrypt sensitive data and remove them
4. git checkout iOS_release, this branch serves the purpose of release
5. Move all files copied in step 1 and encrypted data in step 2 into current project
6. Create a new commit
7. git push ios HEAD:refs/tags/iOS_v1.0 (or git push ios iOS_release:/refs/tags/iOS_v1.0)