Lee Wei

Python Programmer Reader Traveler Ukulele Player Locker Star Wars Fan

Contact me

What is Git?

版本控制系統
(Version Control System)

那版本控制又是什麼...

• 有沒有Code改著改著就回不去的經驗?
• 還是複製了太多備份不知道哪份才是要用的?

占空間，難維護

Git只會記錄每一次有差異的部份

What can version control do for us?

1. Historial propose
   • 也就是存檔，讓之後Code寫錯了可以回朔
2. Collaboration
   • 自動整合不同人寫的Code
     (如果沒有同一段Code被不同人修改)

Install Git

• Linux
• Mac
• Windows

Install on Linux

    
yum install git-core
    
  

    
sudo apt-get install git
    
  

Install for Mac

    
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    
  

    
brew install git
    
 

Install for Windows

Setup

Set E-mail and Name

git config --global user.name "Your Name"
git config --global user.email "Your Email"
  

Set Alias

懶人必備

git config --global alias."command alias" "original command"
  

git config --global alias.st status
git config --global alias.cmt commit
git config -–global alias.br branch
git config --global alias.ch checkout
  

List Settings

git config --global -l
  

git config -l
  

Edit Settings

git config --global -e
  

Quick Start

Create a local repo

• 什麼是repo?
  • repository，git都是這麼稱呼它的版本庫
  • 可以想成就是要加入版本控制的專案
  
  
• 初始一個git專案(讓這個資料夾被git記錄)

git init "some path"
    

Create a local repo

• .git
  • 這個隱藏資料夾紀錄了git所有的操作
  • 裡面都是一般的file，沒有daemon或背景作業
  • 建議沒事就不要去動它了
  • 絕對不要對他rm -rf .git，不然git的紀錄就會全部不見
• master
  • master是目前所在分支的名稱，分支的概念會在以後的章節提到
  • 至於像這樣在terminal顯示分支名稱，則是oh-my-zsh-powerline-theme的功能

Stage

git status
  

git st
  

接下來會說明各個stage代表的意義

Stage

0. untracked

   (新的檔案，還沒加入git中)

1. unmodified

   (完成add，但還沒commit)

2. modified

   (add完後又做了修改)

3. staged

   (commit完成，到這個階段就已經完成紀錄)

Stage 3 - staged

Stage 0 - untracked

• 建立一個檔案叫hi.txt
• 現在有一個檔案進入untracked

Stage 1 - unmodified

git add "file name"
  

Stage 1 - untracked

Stage 1 - unmodified

git add .
  

Stage 3 - staged

git commit
  

git config --global core.editor "vim"
  

Log

git log
  

Stage 2 - modified

Stage

• 新增檔案 → 加入track (git add) → 提交(git commit) → 繼續加入其他檔案
• 修改檔案 → 加入stage (git add) → 提交(git commit) → 繼續修改其他檔案

Commit

敘述這次做的修改

How to write a good git commit

• Priciple
  • 為每個不同的修改做一次commit
  • 不要一個commit中記錄太多的修改
  • 讓你的commit說一個故事
• More Specific
  • 第一行應該在80字以下
  • 使用現在式
  • 不要去重複任何可以在git diff中被找到的東西
  • 更多的細節，應該空下第二行，從第三行開始寫
  • 在第三行以後，提到為什麼做了這次的修改

How to write a good git commit

• 5 Useful Tips For A Better Commit Message
• 該如何寫好 git commit message
• 請不要 commit 已經註解的程式碼

Commit

git commit --amend
  

diff

diff

          git diff "target"
            

diff

          git diff a b
            

          git diff
            

          git diff --staged
            

Restore

git checkout "file name"
  

git reset "file name"
  

Restore

git reset "可被辨識的commit SHA1碼"
    

commit後面那串就是每個commit自己的SHA1
一般只要前四碼就能讓git辨別是不同的commit
但如果是比較大型的專案，可能會需要比較多碼

Restore

reset後"不會"回到到第一次commit的狀態
所有檔案的內容還是跟reset前一樣
只是commit的紀錄回到了第一個commit (只是把存檔點往前移)
這時候要git checkout hi2.txt (執行回到存檔點的動作)
hi2.txt才會回到第一次commit時的內容

Restore

git reset --HARD "可被辨識的commit SHA1"
  

Restore

• 如果後悔reset怎麼辦？
  • 沒關係，東西其實都還在，再reset回去就好了
• 查看所有的參照日誌

git reflog
  

Restore

• 這些長長的SHA1碼，看了就覺得煩啊
• git可以使用"~n"來表示前n次的commit
  • HEAD: 最近一次的commit
  • HEAD~1: 前兩次的commit
  • HEAD~n: 前n+1次的commit

git reset HEAD~n
  

Restore

git reset HEAD~n "file name"
  

reset vs checkout

• soft reset不會改變現在檔案的內容
  而是改變HEAD指向的位址
• checkout才能把現在的檔案回復到之前的狀態

???...

沒關係，看看下一頁的例子吧

reset vs checkout

這是git log現在的內容 待會會看第一個commit 94dc 和第三個commit 4f03

上面cat的結果是commit 4f03 中 hi.txt的內容 下面則commit 94db 中 hi.txt的內容

reset vs checkout

Ignore File

• 有些檔案不想被加入git追蹤該怎麼辦？
  • 那就忽略它吧！
  • 通常會ignore有機密資料的檔案或暫存檔

    
    echo "filename" >> .gitignore
              

  • 要忽略特定副檔名的檔案，可以用萬用字元
    

    
    echo "*.swp" >> .gitignore
              

• .gitignore也必須被加入git追蹤
• .gitignore不用也不能加./在檔案名稱前面
• 這方法只適用在還沒加入追蹤的檔案

Ignore File

先將他從版本庫移除

git rm --cache "file name"
  

接著再做一次上一頁的步驟，就可以ignore了

Ignore File Globally

git config --global core.excludesfile "path to global gitignore"
  

gitignore.io

gitignore.io提供了不同語言.gitignore範本
透過git-extras的git ignore-io可以直接從command line取得範本
另外git-extras的git ignore，也能讓ignore file更輕鬆

Branch

• Branch是git很重要的功能
  • 想像成複製很多份同樣的code，各自做不同的修改
  • 通常可以用在測試或攥寫新功能
• 可以想像是解支線任務
  • 切出支線解不同的任務，每一個支線都能有自己的存檔
  • 最後再整併成主線的一部份(也可以不整併)

Branch

git branch "branch name"
  

git checkout "branch name"
  

git checkout -b "branch_name"
  

What actually is branch?

branch並不是真正的copy，比較像是一個書籤
它只是一個指到某一個commit
實際上git還是以這些sha碼來辨別該到哪一個紀錄

HEAD指的是目前commit所指向的位置
後面的master和my-branch就是我們的分支
而我們的這個分支目前都是指向4f03e7a...這個commit上

Branch

我們在my-branch跟master上都做了修改，並分別commit後
就能比較明確看出分支的效果

這時候就可以看到master跟branch指向不同的commit
也不再是同一條線上

Branch

Merge

Merge

• 將另一個branch合併到現在的branch

  
  git merge "branch name"
        

  通常會在branch修改完並commit後，切換到master才merge
• 之後就能把合併完的branch刪掉

  
  git branch -d "branch name"
        

• 如果想強制刪掉還沒merge的branch

  
  git branch -D "branch name"
        

Merge

完全不同的內容，git會怎麼處理呢？

Merge

來看一下現在status長怎樣

git 已經幫我們判斷其他檔案並沒有衝突
只剩下hi.txt有無法被演算法整併的內容

Merge

這時候打開hi.txt，git會標示哪裡是哪個branch的內容

<<<HEAD到===的內容就是HEAD(目前指向master)的內容
下面則是my-branch的內容

Merge

Rename branch

git branch -m "oldname" "newname"
  

git branch -m "newname"
  

tag

tag

• 在現在的commit上，建立一個tag

  
  git tag -a "tag name"
                  

• 列出所有的tag

  
  git tag
                  

• 觀看某一個tag的詳細資訊

  
  git show "tag name"
                

tag

Remote

What is github

• 可以將原始碼開放到網路上的網站
• 很多厲害的的open source project都來自這
• 私有專案是要付費的
  (需要私有專案可以試試看bitbucket或gitlab)

Remote

Remote

接著就會看到這個頁面

因為我們已經有本地的git專案了，我們只要看

git remote add origin https://github.com/Lee-W/Git-Tutorial-Sample.git
git push -u origin master
  

Remote

git remote add "remote-name" "remote url"
  

• 上一頁的origin就是remote name
• remote url則是https://github.com/Lee-W/Git-Tutorial-Sample.git
• origin只是預設的remote name，並沒有強制一定要存在
• 一個專案也有可能有超過一個remote

Remote

git remote -v
  

Push your repo

git push -u "remote name" "branch name"
  

接著用git branch --all可以看到遠端的master分支已經存在了

Push your repo

git push --all
  

Credential

git config --global credential.helper cache
  

What should be in a repo?

• 程式碼
• README.md
  • 說明專案該如何使用
  • 以markdown語法攥寫
  • GitHub會自動去找readme，README等字眼，並建立出對應的說明文件
  • GitHub使用的是GitHub Favored Markdown
• LICENSE.txt

What shouldn't be in a repo?

• 任何機密資料(e.g. 密碼)
• 暫存檔(e.g. .swp, __pycacehe__)
• Binary檔
• 很大的檔案（如果有必要，可以試試git-annex）

Clone

git clone "repo url"
  

Pull

git pull "remote name" "branch name"
  

What did pull do?

Pull實際上做了fetch和merge命令的動作

git fetch做的只是從遠端抓下來
讓我們可以checkout到 "remote name"/"branch name"這個分支
並不會像pull一樣處理merge的動作

因為我們並沒有做修改，master跟origin/master都是指像同樣的地方

Other Remote Operation

git remote rename "old name" "new name"
  

git remote rm "remote name"
  

Remote branch

• Check遠端分支

  
  git fetch
  git branch -a
  git checkout "branch name"
        

• Clone單一遠端分支

  
  git clone "url" --branch "branch name" --single-branch "directory"
        

  如果不指定directory，就會clone到當前目錄

Remote branch

• 刪除遠端分支

  
  git push -d "remote name" "branch name"
        

• 清理過時的遠端分支
  (在遠端已經被移除，本地端紀錄遠端分支存在)

  
  git remote prune "remote name"
        

Remote Tags

• Push單一Tag

  
  git push "remote name" "tag name"
        

• Push所有Tag

  
  git push "remote name" --tags
        

History

log

log

git log --decorate
  

log

git log --all
  

log

git log --graph
  

log

同時使用--graph, --all, --decorate就能看到我在branch章節用來解說用的結果


也可以直接將這些參數alias到簡單的指令讓下次使用更輕鬆

    
git config --global alias.lg "log --grpah --decorate --all"
    
  

log

  git log --follow "file name"
  

show

  git show "commit or tag"
  

show

  git show "commit":"file name"
  

stash

stash

這時候線圖看起來會是這樣的
my-branch比master多了一個commit

stash

接著我們再對master上的hi.txt做一些修改
如果這時候要checkout到my-branch上

git就會警告我們必須要先commit或stash

但我們可能還沒有做到一個適合commit的階段
這時候就能用stash暫存起來

stash

git stash
  

這時候hi.txt就會回到原本的狀態

stash

git stash list
  

stash

git stash apply "stash name"
  

這時候就能看到
hi.txt又變成我們更改過後的狀態

stash

git stash drop "stash name"
  

rebase

rebase

rebase

這裡只會介紹基本的interactive rebase

假設我們多了兩個commit
其中有一個commit只是修復打錯字
我們希望能把它整併進上一個commit

rebase

git rebase -i "SHA1"
  

接著就會進入rebase的互動介面
下面有說明可以進行哪些動作

rebase

再去看log就會發現typo這個commit不見了

rebase

rebase

git rebase --abort
  

Pull with rebase

git pull --rebase
  

submodule

submodule

加入submodule

    git submodule add "repo url" "some path"
  

假設要把現在這份投影片的repo
加入原本的專案

Submodule

Submodule

submodule

pull所有submodule

git submodule foreach --recursive git pull "remote name" "branch name"
  

連同submodule一起clone下來

    git clone --recursive "url"
  

Reference

• Git Document
• How do I rename the local branch?
• How do you remove an invalid remote branch reference from Git?
• How to clone a single branch in git?
• global git ignore 小撇步
• Git Submodule 用法筆記
• pull latest of all submodules
• clone includenig submodules