Skip to content

Latest commit

 

History

History
169 lines (124 loc) · 8.18 KB

flow.md

File metadata and controls

169 lines (124 loc) · 8.18 KB
Raw

Framgia Git flow

Flow tham khảo: A successful Git branching model

Giả định

  • Đã tạo Central Repository (Nguồn trung tâm) trên Github（hoặc Bitbucket）.
  • Branch mặc định của Central Repository là master.
  • Lập trình viên có thể fork (tạo nhánh) đối với Central Repository.
  • Đã quyết định người review và người có quyền merge.

Nguyên tắc

  • Mỗi pull-request tương ứng với một ticket.
  • Mỗi một pull-request không hạn chế số lượng commit
  • Pull-request title phải đặt sao cho tương ứng với title của task với format refs [Loại ticket] #[Số ticket] [Nội dung ticket] （Ví dụ: refs bug #1234 Sửa lỗi cache）.
  • Đối với commit title, trong trường hợp pull-request đó chỉ có 1 commit thì có thể đặt commit title tương tự như trên là refs [Loại ticket] #[Số ticket] [Nội dung ticket] （Ví dụ: refs bug #1234 Sửa lỗi cache）.
    Tuy nhiên với trường hợp 1 ppull-request có chứa nhiêù commit thì cần phải ghi rõ trong nội dung commit title là trong commit đó xử lý đối ứng vấn đề gì.
    • Ví dụ:
      1. Pull-request title: refs bug #1234 Sửa lỗi cache
      2. Trong trường hợp pull-request có 2 commit thì nội dung commit title của 2 commit sẽ tương ứng như sau
        • Tạo method thực hiện việc clear cache trong Model
        • Tại controller gọi method ở Model để thực hiện việc clear cache
  • Gitflow đến thời điểm 2018/03/28 có quy định là 1 pull-request chỉ một commit sẽ không còn hiệu lực nữa. Tuy nhiên với các dự án mà teamsize lớn hơn 10 người thì để nhằm mục đích cho thuận tiện cho việc confirm thì khuyến khích dùng squash and merge .
  • Ngoài ra thì với gitflow trước đây ( trước thời điểm 2018/03/28) thì có cho phép dùng force push, tuy nhiên do khi sử dụng force push sẽ xoá hết lịch sử thay đổi do vậy gitlow hiện tại không khuyến khích sử dụng force push. Trong trường hợp cần sử dụng force push thì cần có sự đồng thuận từ team.
  • Tại môi trường local(trên máy lập trình viên), tuyệt đối không được thay đổi code khi ở branch master.Nhất định phải thao tác trên branch khởi tạo để làm task.

Chuẩn bị

  1. Trên Github (Bitbucket), fork Central Repository về tài khoản của mình（repository ở tài khoản của mình sẽ được gọi là Forked Repository）.

  2. Clone (tạo bản sao) Forked Repository ở môi trường local.Tại thời điểm này, Forked Repository sẽ được tự động đăng ký dưới tên là origin.

    $ git clone [URL của Forked Repository]

  3. Truy cập vào thư mục đã được tạo ra sau khi clone, đăng ký Central Repository dưới tên upstream.

    $ cd [thư mục được tạo ra]
$ git remote add upstream [URL của Central Repository]

Quy trình

Từ đây, Central Repository và Forked Repository sẽ được gọi lần lượt là upstream và origin.

  1. Đồng bộ hóa branch master tại local với upstream.

    $ git checkout master
$ git pull upstream master

  2. Tạo branch để làm task từ branch master ở local. Tên branch là số ticket của task（Ví dụ: task/1234）.

    $ git checkout master # <--- Không cần thiết nếu đang ở trên branch master
$ git checkout -b task/1234

  3. Tiến hành làm task（Có thể commit bao nhiêu tùy ý）.

  4. Push code lên origin.

    $ git push origin task/1234

  5. Tại origin trên Github（Bitbucket）、từ branch task/1234 đã được push lên hãy gửi pull-request đối với branch master của upstream.

  6. Hãy gửi link URL của trang pull-request cho reviewer trên chatwork để tiến hành review code.

    6.1. Trong trường hợp reviewer có yêu cầu sửa chữa, hãy thực hiện các bước 3. 〜 5.. 6.2. Tiếp tục gửi lại URL cho reviewer trên chatwork để tiến hành việc review code.

  7. Nếu trên 2 người reviewer đồng ý với pull-request, người reviewer cuối cùng sẽ thực hiện việc merge pull-request. Revewer xác nhận sự đồng ý bằng comment LGTM.

  8. Quay trở lại 1.

Đối với dự án áp dụng quy định tương ứng với 1 pull-request chỉ cho phép 1 commit

Từ đây, Central Repository và Forked Repository sẽ được gọi lần lượt là upstream và origin.

  1. Đồng bộ hóa branch master tại local với upstream.

    $ git checkout master
$ git pull upstream master

  2. Tạo branch để làm task từ branch master ở local. Tên branch là số ticket của task（Ví dụ: task/1234）.

    $ git checkout master # <--- Không cần thiết nếu đang ở trên branch master
$ git checkout -b task/1234

  3. Tiến hành làm task（Có thể commit bao nhiêu tùy ý）.

  4. Trường hợp đã tạo nhiều commit trong quá trình làm task、tại 5. trước khi push phải dùng rebase -i để hợp các commit lại thành 1 commit duy nhất.

    $ git rebase -i [Giá trị hash của commit trước commit đầu tiên trong quá trình làm task]

  5. Quay trở về branch master ở local và lấy code mới nhất về

    $ git checkout master
$ git pull upstream master

  6. Quay trở lại branch làm task, sau đó rebase với branch master.

    $ git checkout task/1234
$ git rebase master

    Trường hợp xảy ra conflict trong quá trình rebase、hãy thực hiện các thao tác của mục「Khi xảy ra conflict trong quá trình rebase」.

  7. Push code lên origin.

    $ git push origin task/1234

  8. Tại origin trên Github（Bitbucket）、từ branch task/1234 đã được push lên hãy gửi pull-request đối với branch master của upstream.

  9. Hãy gửi link URL của trang pull-request cho reviewer trên chatwork để tiến hành review code.

    9.1. Trong trường hợp reviewer có yêu cầu sửa chữa, hãy thực hiện các bước 3. 〜 6.

    9.2 push -f (push đè hoàn toàn lên code cũ) đối với remote branch làm task.

    $ git push origin task/1234 -f

    9.3 Tiếp tục gửi lại URL cho reviewer trên chatwork để tiến hành việc review code.

  10. Nếu trên 2 người reviewer đồng ý với pull-request, người reviewer cuối cùng sẽ thực hiện việc merge pull-request. Revewer xác nhận sự đồng ý bằng comment LGTM.

  11. Quay trở lại 1.

Khi xảy ra conflict trong quá trình rebase

Khi xảy ra conflict trong quá trình rebase, sẽ có hiển thị như dưới đây (tại thời điểm này sẽ bị tự động chuyển về một branch vô danh)

$ git rebase master
First, rewinding head to replay your work on top of it...
Applying: refs #1234 Sửa lỗi cache
Using index info to reconstruct a base tree...
Falling back to patching base and 3-way merge...
Auto-merging path/to/conflicting/file
CONFLICT (add/add): Merge conflict in path/to/conflicting/file
Failed to merge in the changes.
Patch failed at 0001 refs #1234 Sửa lỗi cache
The copy of the patch that failed is found in:
    /path/to/working/dir/.git/rebase-apply/patch

When you have resolved this problem, run "git rebase --continue".
If you prefer to skip this patch, run "git rebase --skip" instead.
To check out the original branch and stop rebasing, run "git rebase --abort".

  1. Hãy thực hiện fix lỗi conflict thủ công（những phần được bao bởi <<< và >>> ）. Trong trường hợp muốn dừng việc rebase lại, hãy dùng lệnh git rebase --abort.

  2. Khi đã giải quyết được tất cả các conflict, tiếp tục thực hiện việc rebase bằng:

    $ git add .
$ git rebase --continue